toodope_open

Source code for toodope.org

How to help: for non-coders

1. If you find a bug, open an issue or contact admin [AT] toodope [DOT] org
2. Upload outlines, write professor reviews, and list textbooks for sale

How to help: for coders

1. Code and add features to the website

Setting up your development environment: for everything except uploading files

1. Clone this repo to your machine.
2. Install the following: node 9.10 or more
3. Create a .env file using .env_sample as a template
4. Install the required node modules by running npm install
5. Start the server by running node server.js
6. You should now be able to see portions of the website at localhost:8080. The search functionality will be broken on most pages. To get search working, contact me at admin [AT] toodope [DOT] org to get access to the database.

Setting up your development environment: for uploading files

1. Do all of the above
2. Install the following: python 3, redis, postgreSQL
3. Install the required python modules by running pip install requirements.txt
4. Create an AWS account and add the credentials to .env variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY. Create an AWS S3 bucket and add the name to .env variable S3_BUCKET. Create a postgreSQL database and add the details to .env variables PG*.
5. Start redis (redis-server --daemonize yes)

License

MIT

If you're a student org looking to set up your own outline bank, feel free to use this code as a template.

Note to self

I upload outlines/reviews under professor name "testing" and course name "testing" to test that nothing broke after my latest changes.