Skip to content

Latest commit

 

History

History
40 lines (22 loc) · 2.18 KB

README.md

File metadata and controls

40 lines (22 loc) · 2.18 KB

kerckhoff logo

Kerckhoff

Kerckhoff is a static-site management and deployment solution used by the Daily Bruin, UCLA's student run daily newspaper.

This project is currently under active development.

Features/Roadmap

You can find the spec here. @media.ucla.edu email required.

Setting up the Dev environment

We are using Docker and Docker-Compose for deployment and development. Feel free to read up more on Docker if you're interested in the details of how it works, or reach out to us on Slack.

  1. Install Docker from the official website. Follow the instructions for your specific platform.

  2. git clone https://github.com/daily-bruin/kerckhoff.git - to clone the repository.

  3. docker-compose up - this builds/pulls and configures the Docker images for the Django server, the Postgres database and Redis automatically based on the configuration in docker-compose.yml.

  4. The site should now be running on localhost:5000, and the server will automatically restart after any edits you make to Python and JS source files. Refresh the page to see them! (To come: livereload)

How do I contribute?

  1. Set up the Dev environment properly.

  2. Look for an open issue (could be a feature or a bugfix) or create one of your own (so we know you're working on a new thing!)

  3. git checkout -b feature/<my-awesome-feature>

  4. Write some badass code.

  5. git add <files I want to update> or git add . (This adds all the files in the current directory - be careful!)

  6. git commit -m <a commit message explaining what you did>

  7. git push - this will usually fail for a brand new feature branch, just follow the instructions on your terminal to resolve it

  8. Create a pull request (request to merge your branch into the master branch) using the button on Github!

! Important ! - Don't commit secret keys or any sort of sensitive information into git! Always do a git status to double check if you're not sure.