This is the Digital Career Institute Dashboard. It has plenty of modules which loop automatically through and inform the audience about upcoming events, github activity or little code snippets.
Stack:
- React
- NodeJS
- MongoDB
A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.
Start frontend
cd frontend && yarn start
Start backend
cd backend && npm run server
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
Test files are next to the components.
Eg: Video.js and Video.test.js
Run test suite locally
npm run tests
Everytime when you push you see the TravisCI build running all tests.
This badge shows the build status for the development branch
Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
A short snippet describing the license (MIT, Apache, etc.)