Manage Your Company 📈

under construction 👷

Technologies 🚀    |    Project 🧑‍💻    |    How to Run back 🏃    |    How to Run front 🏃    |    How to contribute 🤔   |    License 📝

🚧 Result

🚀 Technologies

This project was developed with:

• Typescript
• NodeJs
• React(Create-React-App)
• Express
• Mongoose
• Mongodb

🧑‍💻 Project

The "ManageYourCompany" 📈 project is a project that creates companies, units and assets. The rule is that every company has multiple units and the units have multiple assets. This is a project with the intention of exercising my Backend skills with NodeJs and front with react.

Units have multiple assets, these assets are machines with multiple fields: name,image,description,model,owner,status,healthLevel.

And the main idea is to visualize the units and assets in general, or to visualize a single specific unit.

🚨 very important

It's very important to have the database powered on (locally) and connected to your mongodb too, it's very important to power on the backend before the front.

🏃 How to Run back

• Make a fork;
• Open the project on your terminal;
• cd/back
• Run yarn install or npm install to install Dependencies;
• Connect with your mongodb in Database folder
• Run yarn dev or npm run dev to run the server;
• By default the server will run at localhost:3000.

🏃 How to Run front

• Make a fork;
• Open the project on your terminal;
• cd/front
• Run yarn install or npm install to install Dependencies;
• Connect with your mongodb in Database folder
• Run yarn start or npm run start to run the server;
• By default the server will run at localhost:3001.

🤔 How to contribute

• Make a fork;
• Create a branch with your feature: git checkout -b my-feature;
• Do commit with your changes: git commit -m 'feat: My new feature';
• Do a push for your branch: git push origin my-feature.

After the merge of your pull request was made, you can delete your branch.

📝 License

This project is under License MIT. See the documentation LICENSE for more details.