Road Sign Manager
Road Sign Manager is a Code4Good at Yale, MakeHaven and New Haven collaborative project to create a cloud platform that can convert and send data to electronic road signs in the city. The project is developed by a team of student developers.
Installation and Usage
git clonethe repository.
.envand set the variables accordingly. Note that
DATABASE_URLis for the production database; the test and development databases use sqlite and run from memory or a file respectively. You can ignore
DATABASE_URLif you don't plan to deploy yet.
npm run devfor development.
- If you want to run on the production database, use
npm testto run tests.
- After installing, go to Settings to add parking spaces and road signs.
- If you wish to change the password or other config variables, go to the settings page of the heroku instance and edit cofig variables.
At the moment, road-sign-manager is developed by a student team at Code4Good at Yale University. However, feel free to create issues and open pull requests.
git clonethe repository if you haven't already.
- Make sure you are on the
git pullto pull the latest updates.
git checkout -b <BRANCH NAME>to checkout a new feature/issue branch. Name the branch after your feature/issue.
- Make the changes and test them locally. Remember to install dependencies with
yarnelse you will get a
module not founderror. When testing, remember to make a COPY of
.env.sampleand name it
.envbefore filling out the environment variables.
- Before proceeding to submit, run
npm run precommitas well as
npm run test.
- When you are ready to submit,
git add .
git commit -m "<CHANGES MADE>"
git push origin <BRANCH NAME>. DO NOT push to
- Open a pull request on Github and assign @spaceraccoon as the reviewer. In your message, remember to add
#<ISSUE NUMBER>so that the request automatically closes the issue when it is merged.
- @spaceraccoon will either approve or suggest changes. If the latter, repeat steps 5-6.