🔒 NavDesk - An Access Control Management System 🔒

Welcome to the Frontend part of NavDesk. This is a Co-Working App project providing interactive and user-friendly interfaces to access "Las Naves" facility in Valencia!

Table of contents 📝

1. About the project
2. Deploy
3. Stack
4. Clone
5. Views
6. Future functionalities
7. Contribution
8. Web refferences
9. Development
10. Appreciation
11. Contact

About the project 📁

This project provides a rich front-end application built with React, TypeScript, Vite, and MUI. It interfaces with the NavDesk backend server to manage access and administration within a co-working space. Users can register, log in, view rooms, make bookings, and admins have additional functionalities like managing room assignments and viewing extensive reports. For admins there is a special part where reports can be obtained and as well detailed history for bookings, users and rooms.

Deploy 🚀

Click here! 🚀🚀🚀

Stack

Used technologies for the project:

Features

• Authentication (Login/Signup)
• Responsive layout optimized for multiple device sizes
• Booking management for rooms
• Admin specific views:
• Room management
• User management

Local installation option ⚙️

Make sure you have the REST API which can be found here - https://github.com/yoanastamenova/NavDesk--back

• Before starting it is important to have SQL and MySQLWorkbench installed locally in order to work with the database. If you dont have it or simply prefer to use a Docker configuration please follow the steps bellow and then you can continue with the clone. -1- Create docker SQL Image docker build -t mssql-app -2- Create a SQL container docker run -d --name mssql-container -p 3306:3306 mssql-app -3- Run Docker Desktop App and run the container from there

1. Clone the repository from the url
2. $ npm install (to get all the node packages)
3. Connect the cloned repo with our Database (if you dont have docker make a mysql container and run it on the wanted port such as: docker run -d --name mysqlc -p 3306:3306 -e MYSQL_ROOT_PASSWORD=root -v mysql_data:/var/lib/mysql mysql)
4. Change variables in .env with the PORT given from Docker (default is 3306)
5. $ npm run migrations
6. $ npm run db:seed
7. $ npm run db:refresh to execute everything from the beginning
8. $ npm run dev to run our server

Views

• Home view

- Reception view

- Login view

Future functionalities

✅ Add calendar view
⬜ Add confirmation via email
⬜ StartUp and old users validations

Contribute to the project 📦

Feel free to suggest an improvment or functionality to my project.

There are two ways of doing this:

1. Opening an issue
2. Creating a fork of the repository
   • Creating a new branch

     $ git checkout -b feature/yourUsername -feat
     

   • Make a commit with your changes

     $ git commit -m 'feat: this X thing'
     

   • Make a push to the branch

     $ git push origin feature/yourUsername -feat
     

   • Opening a Pull Request

Web refferences 📧

To achieve my project I used data from the following sites:

• google.com
• pinterest.com
• spacebring.com
• ...

Development 📌

const developer = "yoanastamenova";

console.log("Developed by: " + developer);

Contact 📤