Company management assets 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

Login : admin
Password : admin

* 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 roadmap to see an incoming changes...
* Check the features to see implemented functionalities.
* Preview available(Login and password : admin) : https://patrykkeska.networkmanager.pl
* Backend Repo : https://github.com/PatrykKeska/company_management_app_backend
* DataBase file for Import purpose : https://github.com/PatrykKeska/company_management_app_backend/tree/main/DataBaseScheme

how are the components arranged?

• I was following something like Atomic Design which means smaller parts of code combine for bigger parts and finally reach whole Page view.

• In Components directory there are smallest components.

• In Layout Directory there are combined components. In result we got kind of views ready to implements on pages.

• In Pages there are Implemented Layouts with Some extra components like Wrapper or Nav

📷 Screenshots

👾 Tech Stack

Client

• Typescript
• React.js
• Styled-Components

Server

• Typescript
• Express.js
• MySql

Database

• MySQL

🎯 Features

• Login/Logout
• Local Storage Session (Possible to change session time in /utils/isTokenExpire.ts)
• RWD
• Creating a new items.
• Items and offices image change( For now only by pasting a link with image address) - incoming file transfer
• 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!

🎨 Color Reference

Color	Hex
Primary Color

🔑 Environment Variables

To run locally make sure backend is listening and database is implemented correctly. More information about database setup and backend going to find out in backend repo here :
https://github.com/PatrykKeska/company_management_app_backend

Login : admin
Password : admin

🧰 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_front.git

Go to the project directory

  cd company_management_app_front

Install dependencies

  yarn install

Start the server

  yarn start

🚩 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

• Basic functionality (check features section)
• Linux Server Host Preview
• Registry a new accounts
• JWT session
• File transfer from Client=>Server and reverse
• Backend in NestJS

⚠️ License

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

🤝 Contact

Patryk Keska - @twitter_handle - [email protected]