An open API service indexing awesome lists of open source software.

https://github.com/ieee-vit/playing-with-numbers-node

A simple node.js app that is used to calculate/check some special types of numbers.
https://github.com/ieee-vit/playing-with-numbers-node

algorithms-and-data-structures api hacktoberfest javascript nodejs opensource

Last synced: 8 months ago
JSON representation

A simple node.js app that is used to calculate/check some special types of numbers.

Awesome Lists containing this project

README

          

# Hacktoberfest 2020 with IEEE-VIT :heart:
Playing with numbers is a simple node.js REST API that gives an output to basic problems such as checking palindrome, armstrong, etc. It's something that is super easy to contribute to and is a great place to get started with open source.

Support open source software by participating in [Hacktoberfest](hacktoberfest.digitalocean.com) and get goodies and a free t-shirt! :yellow_heart:

> Please check all issues labelled as `hacktoberfest` to start contributing!

Kindly consider leaving a :star: if you like the repository and our organisation.

## Getting Started
* Fork it.

* Clone your forked repo and move inside it:

`git clone https://github.com//playing-with-numbers-node.git && cd playing-with-numbers-node`

* Checkout to a new branch to work on an issue:

`git checkout -b my-amazing-feature`

* To get started, ensure you have node and npm installed on your device.
* Execute the follwing command to get all the required dependencies

`npm install`
* To start the server, execute the following command

`npm start`

* In order to run tests, execute the following command

`npm test`

* All the routes have been setup inside the 'routes/routes.js' file. You can create new routes and add the logic to the respective feature there.

* All the tests have been setup inside the 'tests/tests/js' file. You can create new tests and add them to the same file.

* Once you're all done coding, it's time to open a PR :)
Run the following commands from the root of the project directory:

`git add .`

`git commit -m "A short description about the feature."`

`git push origin `

Open your forked repo in your browser and then raise a PR to the `master` branch of this repository!

## Contributing
To start contributing, check out [CONTRIBUTING.md](https://github.com/IEEE-VIT/playing-with-numbers-node/blob/master/CONTRIBUTING.md). New contributors are always welcome to support this project. If you want something gentle to start with, check out issues labelled as `easy` or `good-first-issue` Check out issues labelled as `hacktoberfest` if you are up for some grabs! :)

## License
This project is licensed under [MIT](https://github.com/IEEE-VIT/playing-with-numbers-node/blob/master/LICENSE)