Welcome to the repo containing all the code for the new Brown Daily Herald website. We welcome open-source contributions to the website by members of the Brown community and reuse of our code under the MIT License, so feel free to fork away.
First, make sure you have virtualenv and Django installed. This can be done via pip install virtualenv (and then creating an appropriate virtualenv by running virtualenv myenv and then source myenv/bin/activate). Then, you should run pip install -r requirements.txt from the directory to which you have cloned this project. There is a known issue that may arise relating to databases; if so, please reach out to one of us. Then, at the command line, run python manage.py makemigrations AND python manage.py migrate before running python manage.py runserver from the main project directory - this will start the Django web server at http://127.0.0.1:8000/. It should update automatically when any changes are made. Finally, to render the front-end, cd into the frontend/ folder and run npm run start, which will start up the React server.
Here at the BDH, we follow certain established industrywide coding style guidelines:
- JavaScript Best Practices: AirBnB suggested guidelines
- Python Best Practices: Official Python Style Guide
- HTML/CSS Style Guide: Official Google HTML/CSS Guide
We operate under the "1 commit per Pull Request" model. To see why, check out the first answer at this link. If you have multiple commits, please squash and rebase according to the workflow shown here. For any other coding style questions, reach out to [email protected].
Questions? Suggestions? Complaints? Email us at [email protected]!
Brought to you by Rahul Jayaraman '19, Alan Yoho '19, Michael Bardakji '20, Megan Gessner '20, Sean Rayment '20, Fangrui Tong '20, Jaja Thepumnoeysuk '21