Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.57 KB

README.md

File metadata and controls

39 lines (26 loc) · 1.57 KB
Raw

Hacktoberfest, 2019 with IEEE-VIT Student Branch

SimpleMath is a node.js REST API that does math for you. This repository was created to help developers get started with Open Source during Hacktoberfest

NOTE: Check out issues labelled as Hacktoberfest and start contributing!

Made with ❤️ by IEEE-VIT

Support Open Source by participating in Hacktoberfest💛

Getting started

  1. To setup this project, simply run the following command:
$ npm install

It should create a node_modules folder, and you're good to go! :)

  1. All the routes are setup inside routes/routes.js. Most of your code should go there.

  2. To start the project, simply run the following command:

$ npm start

  1. All the unit tests are located inside tests/test.js. All the tests should go there.

  2. To run the test suite, execute the following command:

$ npm run test

Contributing

To start contributing, check out CONTRIBUTING.md. New contributors are always welcome to support this project. Check out issues labelled as Hacktoberfest if you are up for some grabs! :)

License

This project is licensed under MIT