Cerebrum are on a miission to empower teacher to deliver high quality knowldge to students.
This project requires NodeJS (version 12.8.4 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.
$ npm -v && node -v
6.4.1
v12.8.4
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
BEFORE YOU INSTALL: please read the prerequisites
Start with cloning this repo on your local machine:
$ git clone https://github.com/Cerebrum-HQ/cerebrum-API.git
$ cd cerebrum-API
To install and set up the library, run:
$ npm install
$ npm start
$ npm test
$ npm run build
This task will create a distribution version of the project
inside your local dist/
folder
$ npm run serve:dist
This will use lite-server
for servign your already
generated distribution version of the project.
Note this requires Building a distribution version first.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Add your changes:
git add .
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request ๐
- Njoli Patrick - ogmaro
See also the list of contributors who participated in this project.