Commit 98137aec authored by Mark Stenglein's avatar Mark Stenglein
Browse files

update readme to actually have setup instructions

parent c4098bcd
# SCHEDULES
Schedules is a web app that allows students to import their class schedules into popular calendar managers. Uses webDAV.
Schedules is a web app that allows students to import their class schedules
into popular calendar managers. Uses webDAV.
## On Contributing
Schedules welcomes all the help it can get, and is currently in opening stages. Join the #schedules slack channel to get involved.
Schedules welcomes all the help it can get, and is currently in opening
stages. Join the #schedules slack channel to get involved.
There are many things that can be done with this project (see the "To Do" section), but sometimes it's the small things that count, so don't be afraid of contributing just a small spelling mistake.
There are many things that can be done with this project (see the "To Do"
section), but sometimes it's the small things that count, so don't be afraid
of contributing just a small spelling mistake.
If you need help at all please contact a SRCT member. We want people to contribute, so if you are struggling, or just want to learn we are more than willing to help.
If you need help at all please contact a SRCT member. We want people to
contribute, so if you are struggling, or just want to learn we are more than
willing to help.
The project manager for this project is [Mark Stenglein](mstengle@gmu.edu), and a lead developer is [David Haynes](dhaynes3@gmu.edu).
The project manager for this project is [Mark Stenglein](mstengle@gmu.edu),
and a lead developer is [David Haynes](dhaynes3@gmu.edu).
Please visit the [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information on this and other SRCT projects, along with other helpful links and tutorials.
Please visit the [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information on
this and other SRCT projects, along with other helpful links and tutorials.
## [Setting everything up for development](https://git.gmu.edu/srct/schedules/wikis/Setup)
## Setting up the Development Environment
Installation requirements for many operating systems are located on the [Project Wiki](https://git.gmu.edu/srct/schedules/wikis/Setup).
### nvm
First install [nvm](https://github.com/creationix/nvm), which allows for node
version management:
`curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.32.1/install.sh | bash`
Next, you will need to install node through nvm (this simplifies the
instructions by making them relatively platform independent).
`nvm install node`
### sqlite
You will need to install sqlite3. How this is done is dependent on your system
but for `apt` systems this is as simple as:
`sudo apt install sqlite3`
A note: This project uses MySQL in deployment, but don't worry about that just
yet.
### Project Dependencies
Simply navigate to the root directory and type `npm install`, and you should
be good to go from there.
Test your installation by running `npm start` and the application should spin
up.
## Deployment
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment