mentored.dev
A gamified learning platform to help you become a web developer.
Β·
Visit
Β·
Get in touch
.
Report Bug
Β·
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
This project uses yarn
instead of npm
. You can install it with Homebrew like so:
brew install yarn
Installing
After you've cloned the repo, running the following steps:
yarn
And then to start the project locally:
yarn dev
Then in your browser, navigate to http:localhost:8000/.
Running the tests
Currently, there are no tests
Deployment
CICD is currently set up with Netlify. When you submit a PR, Netlify App will deploy a preview and add a link in the PR. You should always PR into the staging
branch which is our QA environment. Once it's approved, Netlify will deploy it to staging.mentored.dev.
When a new version is ready, you can submit a new PR to merge staging
into master
. This will deploy to the main URL for the app mentored.dev
Built With
- gatsby.js - The React web framework used
- TypeScript - "JavaScript that scales"
- ApolloClient - GraphQL client
- OneGraph - Used to integrate with GitHub OAuth
- styled-components - CSS-in-JS solution
Contributing
Please check the CONTRIBUTING.md for details.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
License
Distributed under the MIT License. See LICENSE
for more information.
Acknowledgments
This project wouldn't be possible without these people and organizations
- Gatsby
- OneGraph
- @TejasQ
- Eric Matyas for music
Contributors
Thanks goes to these wonderful people (emoji key):
Prince Wilson | Bolaji Ayodeji | Andre Goncalves | Angie Jones | Jake Riordan | Tejas Kumar | Chris |
Sean Grove |
This project follows the all-contributors specification. Contributions of any kind welcome!