By Douglas Tesch

References

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

About the Project

A platform to connect cities majors with people simplifying the public request for maintenance of the city by popular votes

Backend

BACKEND Created By - PierreAndreis

A RESTful API using Node.js with Express

🚀 Tecnologies

• ⚡ Express — A web framework for Node.js
• 🔒 Bcryptjs — A library to handle password hash
• 📠 Cors — A protocol that enables interaction with resources from a different origin
• 🔑 Jsonwebtoken — An internet standard for creating JSON-based access tokens
• 📎 Multer — A Node.js middleware for handling multipart/form-data- 📝 Yup — A JavaScript schema builder for value parsing and validation
• 📈 Prisma - Prisma is an awesome open-source database toolkit

Requirements ✋🏻

• Node.js
• Yarn

Install 🔥

1. Clone this repository;
2. Go inside the folder cd your-city-forum;
3. Run $ yarn to install dependencies;
4. Run $ yarn db:migrate to run all migrations;
5. You can use insomnia to try the routes if you whant

Run 🔥

1. Run $ yarn dev to run the server;

Frontend

A ReactJS project created with create react-app

🚀 Some Tecnologies used 🔥

• Unform
• Axios
• React Hooks
• React Router Dom
• Styled Components
• Yup

🚀 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
• eslint-plugin-react-hooks

Install 🔥

1. Go to $ cd your-city-forum/web;
2. Run $ yarn to install dependencies;

Run 🔥

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

Usage Tips

• Login
• Create topic
• Vote
• Search by title
• Logout

Login

Create topic

Vote

Search by title

Logout

Contato

🔗 Linkedin

---

📝 License

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

Back to top ⬆️