Base Mock API's
Project made 100% with JavaScript, with the objective of creating endpoints to use in projects.
Prerequisites
Before you begin, ensure you have met the following requirements:
Installing Base Mock API's
To install the project for both Windows and macOS, you must complete the following steps:
Windows, Linux and macOS:
git clone https://github.com/CabralArthur/base-mock-api.git
cd [path-of-your-project]
npm install [or] yarn install
π Ready!
Using the project
To use locally in your machine, follow these steps:
cd [path-of-your-clone]
npm start [<-- Run this command in terminal]
Contributing to Mock API's
To contribute to the projet, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to the original branch:
git push origin <project_name>/<location>
- Click the Compare & pull request button.
- Click Create pull request to open a new pull request.
Alternatively see the GitHub documentation on creating a pull request.
Contributors
Thanks to the following people who have contributed to this project:
- @CabralArthur
π
Contact
If you want to contact me you can reach me at [email protected].
License
This project uses the following license: MIT License.