Readme

📔 Table of Contents

About the Project
Screenshots
Tech Stack
Features
Color Reference
Environment Variables
Getting Started
Prerequisites
Installation
Running Tests
Run Locally
Deployment
Usage
Roadmap
Contributing
Code of Conduct
FAQ
License
Contact
Acknowledgements

🌟 About the Project

In the beginning, I want to say I created a guide about deploying applications to the Nginx server. There is a lot about correctly configuring and handling environment variables, database config, etc

Everything is in:

 company_management_app_backend_nest/Guide/MyDevil Hosting Nest...pdf 

Backend Repository

https://github.com/PatrykKeska/company_management_app_backend_nest````

The project has separate branches for deployment.

React:

- branch [version_2.0] for localhost
- branch [production] for deployment

NestJs:

- branch [main] for localhost
- branch [deploy] for deployment

Basic Concept of view was created in Figma:

https://www.figma.com/file/5TNV2aSijVHNTm0f8phW7u/Projekt-Zaliczeniowy?node-id=0%3A1

App is still in development; right now has basic features implemented.

Check the roadmap to see incoming changes... Check the features to see implemented functionalities.

Preview available: https://kendziior4.usermd.net/

Preview Email: "admin@gmail.com"

Preview Password: "admin."

📷 Screenshots

👾 Tech Stack

Client

• Typescript
• React.js
• Styled-Components

Server

• Typescript
• NestJS
• TypeOrm

Database

• MySQL

🎯 Features

• Login/Logout
• JWT Session
• Safe File Transfer
• User Passwords encryption
• User Registration
• Local Storage Session (Possible to change session time in /utils/isTokenExpire.ts)
• RWD
• Creating a new items.
• Editing items in storage.
• Deleting items from storage.
• Assign items to office.
• Deleting items from assigned offices.
• Summary of office.
• Creating of new offices.
• Editing of existing offices.
• Deleting offices
• Keeping up to date all your resources in your offices

Check the Roadmap to find an incoming features!

🔑 Environment Variables

In my guide on the chapter: "Environment variables".
There is more about configuration env variables. check it out here:
company_management_app_backend_nest/Guide/MyDevil Hosting Nest...pdf
If you want to run a project locally easiest way to do it: use my secret file scheme and fill up all values according to your database

In this file, you will also find the Salt variable which is responsible for the hashPwd function. Make sure is long and complicated enough

Also, there is a jwtConstants which also should be unique and complicated

src/secretFile.ts

export const dbConnection = {
  DB_CONNECTION: 'mysql',
  DB_HOST: 'localhost',
  DB_USERNAME: 'Database User Name',
  DB_PASSWORD: 'Database User Password',
  DB_DATABASE: 'Database Name',
};

export const SALT = 'Salt for hash pwd';

export const jwtConstants = {
  secret: 'secret for jwt',
};

To run locally make sure backend is listening and database is implemented correctly.

You can check my quick video guide to see how to run the application on your localhost

I'm working on the multi-user application, so the registry page on the frontend app is disabled.

After the project runs, please click the button "create default account"
you are able to use the account :

email: admin@gmail.com
password: admin

ATTENTION! This is crucial to remove this endpoint when you deploy the app! It is a temporary solution to an easy start with a project locally.

🧰 Getting Started

‼️ Prerequisites

This project uses Yarn as package manager

 npm install --global yarn

⚙️ Installation

Install my-project with npm

  yarn install my-project
  cd my-project

🏃 Run Locally

Clone the project

  git clone https://github.com/PatrykKeska/company_management_app_backend_nest.git

Go to the project directory

  cd company_management_app_backend_nest

Install dependencies

  yarn install

Start the server

  yarn start:dev

🚩 Deployment

To deploy this project run

  yarn build

👀 Usage

App can be used as your own managing tool to help you out sort and keep up to date your company assets in local offices etc. This is basic concept and still lot of features has to be implemented.

🧭 Roadmap

• Linux Server Host Preview
• JWT session
• File transfer from Client=>Server and reverse
• Backend in NestJS
• much more user-friendly interface
• better UX/UI
• multi-user platform
• email registration

⚠️ License

Distributed under the no License. See LICENSE.txt for more information.

🤝 Contact

Reach me on Twitter - @twitter_handle
Reach me on LinkedIn - @linkedin_handle
Reach me by email - PatrykKeska4@gmail.com