By Douglas Tesch

References

• References
• About the Project
• Backend
  • Tecnologies
  • Requirements
  • Install
  • Run
• Frontend
  • Some Tecnologies used
  • Helper development tools
  • Install
  • Run
  • First Login
• Mobile
  • Some Tecnologies used
  • Helper development tools
  • Requirements
  • Install
  • Run
  • Usage Tips
• Contato
• License

About the Project

The delivery service FastFeet is an application similar to the post offices. Manager (web) and employees/delivery man (mobile) consuming it's own API.

Backend

A RESTful API using Node.js with Express

🚀 Tecnologies

• ⚡ Express — A web framework for Node.js
• 💾 Sequelize — SQL dialect ORM for Node.js
• 💻 Sentry — An open-source platform to monitoring errors in real-time.
• 🔒 Bcryptjs — A library to handle password hash
• 🐝 Bee-queue — A job/task queue for Node.js
• 📠 Cors — A protocol that enables interaction with resources from a different origin
• ⏰ Date-fns — A library to deal with date and time
• 🔑 Jsonwebtoken — An internet standard for creating JSON-based access tokens
• 📎 Multer — A Node.js middleware for handling multipart/form-data
• 📫 Nodemailer — A module for Node.js to allow email sending
• 👓 Youch — Pretty error reporting for Node.js that helps erros to be easier to read
• 📝 Yup — A JavaScript schema builder for value parsing and validation
• 👾 Express-Brute — A brute-force protection middleware for express that block massive requests.
• 📰 Ioredis — A Redis client.
• 📈 Express-rate-limit — A IP rate limiting middleware for Express.

Requirements ✋🏻

• Node.js
• Yarn
• Postgresql
• Redis

Install 🔥

1. Clone this repository;
2. Go inside the folder cd fastfeet;
3. Run $ yarn to install dependencies;
4. Copy the content of .env.example inside a a new archive .env then insert your credentials;
5. Run $ yarn sequelize db:create to create the database;
6. Run $ yarn sequelize db:migrate to run all migrations;
7. Run $ yarn sequelize db:seed:all to run all seeds;
8. Import fastfeet-insomnia.json that is at the root of this repository inside

Run 🔥

1. Run $ yarn queue to run all background jobs;
2. Run $ yarn dev to run the server;

Frontend

A ReactJS project created with create react-app

🚀 Some Tecnologies used 🔥

• Material UI
• Unform
• Axios
• Date-fns
• Immer
• React Hooks
• Prop-Types
• React Router Dom
• Redux
• React Redux
• Redux Persist
• Redux Saga
• Styled Components
• Yup
• React Select
• React Input Mask
• Reactotron
• reactotron-react-js
• reactotron-redux
• reactotron-redux-saga

🚀 Helper development tools

• Babel
• babel-eslint
• babel-plugin-root-import
• ESLint
• eslint-config-airbnb
• eslint-plugin-import
• eslint-plugin-jsx-a11y
• eslint-plugin-react
• eslint-import-resolver-babel-plugin-root-import
• Prettier
• eslint-plugin-prettier
• eslint-config-prettier
• EditorConfig
• customize-cra
• eslint-plugin-react-hooks
• react-app-rewired

Install 🔥

1. Go to $ cd fastfeet/frontend;
2. Run $ yarn to install dependencies;

Run 🔥

1. Open another terminal, go to $ cd fastfeet/backend;
2. Run $ yarn dev to start the server Backend;
3. Run $ yarn dev to start the React APP;

First Login ✔️

Login:admin@fastfeet.com

Password:123456

Mobile

⚠️ ANDROID ONLY ⚠️

Bare project created with react-native init

🚀 Some Tecnologies used 🔥

Most libraries used here are the same as in frontend, that's the beauty in React, but of course there are some differences.

• React Navigation
• React Native Community/Async storage
• React Native Camera
• React Native Vector Icons
• Reactotron React Native

🚀 Helper development tools

Most are also alike as frontend, but of course there are some differences.

• ESLint
• react-native-community/eslint-config

⚠️ Requirements ✋🏻

• 📱 Android emulator — Guid to setup environment

Install 🔥

1. Go to $ cd fastfeet/mobile;
2. Run $ yarn to install dependencies;

Run 🔥

1. Open another terminal, go to $ cd fastfeet/backend;
2. Run $ yarn dev to start the server Backend;
3. Open your emulator;
4. Open another terminal, go to $ cd fastfeet/mobile;
5. Run $ yarn start to start Metro Bundler;
6. Open another terminal, inside$ cd fastfeet/backend;
7. Run $ yarn android to run the android project;

Usage Tips

• Press and hold to withdraw
• Withdraw hours limit
• Pull to Refresh
• Drop down problem
• Drop down problem
• Slide to go back
• Send picture confirmation or take again

Press and hold to withdraw

Withdraw hours limit

Pull to Refresh

Drop down problem

Slide to go back

Send picture confirmation or take again

Contato

🔗 Github

🔗 Linkedin

---

📝 License

This project has MIT license. Look at LICENSE for details.

Back to top ⬆️