fmsrodrigues / fastfeet

:truck: Fullstack app to manage a delivery company :truck:

FastFeet is a project to help an imaginary distributor manage their recipients, orders and deliverers. 📦

Index

• Getting Started
• Contributing
• Contact
• Notes
• License

Getting Started

To start using FastFeet project you will need to install some tools.
Each piece of the project contains small specifics requirements to run it that will be explained on their properly folder readme.
The next steps are requirements that are common to all of them.

1. Install Node.js.
2. Install a node package manager of your choice, as Yarn.
3. Get an API request builder, as insomnia, postwoman or postman.
4. Import Insomnia_2020-04-14.json file, found on this folder, in your API request builder.
5. Install a code editor of your choice, as VSCode.

Now you're ready to setup FastFeet's back, front and mobile.

Contributing

To contribute to FastFeet, follow these steps:

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name>.
3. Make your changes and commit them: git commit -m '<commit_message>'
4. Push to the original branch: git push origin <project_name>/<location>
5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

Contact

If you want, for any reason, to contact me, you can reach me at [email protected]. 📧

Notes

• FastFeet is a project proposed by Rocketseat in the GoStack bootcamp. 🚀
• This project focus only in practicing and exibithing all the knowledge I gathered through courses, guides and others projects across the years.
• Last feature update commit: 2020/04/18

License

FastFeet is under the MIT License.