Backend: A system that supports APIs to access data about Events and Organizations etc. on Cornell's Ithaca campus.
Website: A web app for student organizations to add events for cue. Here is a list of related repositories:
You will need Python 3.6 to run the latest version of this app, which uses Django 2.0.1. Django can be installed using python's inbuilt pip function.
You will need IntelliJ IDEA v2018.2.5 to run the latest version of this app, which uses the following:
- React.js v.16.4.2
- Material-UI v.3.0.1.
If typing python gives you version 3.x):
pip install -r requirements.txt
Otherwise:
pip3 install -r requirements.txt
Linux/Mac:
npm run copy-settings
Windows:
npm run copy-settings-windows
If typing python gives you version 3.x):
python manage.py makemigrationspython manage.py migrate
Otherwise:
python3 manage.py makemigrationspython3 manage.py migrate
Before you run anything, do this right after git pull:
-
Run
npm iin the project directory to install any additional front-end frameworks. -
Run depending on platform:
- Linux/Mac, python 3 is default:
npm run start - Linux/Mac, python 2 is default:
npm run start3 - Windows, python 3 is default:
npm run start-windows - Windows, python 2 is default:
npm run start3-windows
This will copy
dev_settings.pyover tosettings.pyinevents_backend, then start Webpack to hot-reload front-end changes as well as starting the Django server to hot-reload back-end changes. Isn't this an amazing script? (You can find it inpackage.json). Thank David later. - Linux/Mac, python 3 is default:
The front-end website will be located at 127.0.0.1:8000.
After pushing any changes to the codebase, let's get your code reviewed. Some general guidelines:
- Before you start changing any code, make sure you're synced with the master branch.
- Create a new branch off master, and give it an informative name.
- Commit your changes to this feature branch. Commit often so that you don't accidentally lose your progress!
- Open a pull request (PR), give it a meaningful title and describe the changes that you made. Take note of any future improvements or any existing bugs with the changes you made. Give some steps as to how to test the changes you've made.
- Notify others of the PR you created, and ask the relevant people to review it for you. They may leave comments and request changes, in which case you should make changes and push new commits to the same branch; the PR will update automatically!
- Finally, when the change is approved by the reviewer, you can go ahead and merge the branch into the master branch.
Some things to watch out for when reviewing someone else's code:
- Is the code documented? Are there comments that give details about what the code is doing?
- Have commented-out lines of code been deleted?
- Are your variable names clear, short, and meaningful?
- Are your functions short and have a single purpose?
- Are there redundancies in your code?
If at any point, your database becomes corrupted or you no longer have db.sqlite3 in the directory:
- Django Rest Framework v. 3.8.2 - A Django library that provides powerful authentication protocols.
- Django Simple History v. 2.0 - A Django library that provides methods to store changes to models, and thus, is used to create app-specific event, org. feeds.
- react-avatar-editor - Similar to Facebook profile picture. Allows you to crop, resize, and rotate an uploaded image. Use for event image upload in event creation.
- Backend API Documentation - An external Apiary documenting the endpoints for our application.
2020
- Jonna Chen - Front-End Developer
- Woosang Kang - Back-End Developer
- Mena Attia - Back-End Developer
2018
- Arnav Ghosh - Back-End Developer
- Jessica Zhao - Back-End Developer
- Jill Wu - Back-End Developer
- Adit Gupta - Back-End Developer
- David Chu - Front-End Developer
- Stacy Wei - Front-End Developer
We are a part of the O-Week/Events team within Cornell Design & Tech Initiative. For more information, see our website here.
Last updated 10/21/2018.