LearnR is an educators application that aims to bring together students and teachers. A teacher will be able to add lesson notes on the platform while will enable students to learn any course syllabus from home. Students can add comments and questions to teachers’ notes.
Live Preview: https://cindyeme.github.io/learnR/
Make sure you have nodejs installed by running the following command:
node -vIf the output is not the version of your nodejs installation, install nodejs from here
After installing nodejs install yarn if you don't have it installed then run yarn to install all the project's dependencies:
yarn startRuns the app in the development mode. Open http://localhost:3000 with your browser to see the result.
To add a dependency, run.
To remove a dependency, run.
We're using eslint for linting and prettier for code formating, make sure you install eslint and prettier plugins in your editor so you can see linting errors as you code and have your code formatted on save by prettier. If formatOnSave doesn't work please google how to set up format on save for the eslint & prettier plugins in your editor 🙃
- All components are in the components folder and styles for those components are in the styles folder.
- Assets are in the assets folder, including images
For detailed information on how to go about contribution. Check out the Contribution Guide
Before sending a PR or making a merge make sure you code is properly formatted. You can easily do that by running
yarn format # in project directory