HaveALook — Desk Booking Application

A web application to book desks in advance.

Table of Contents

1. About
   • Key Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License

About

This project is a flexible web application built to help manage shared office space efficiently. It solves a key problem: "Who works where, and when?"

Key Features

• Calendar View — Navigate to upcoming weeks and see bookings at a glance
• Log in/Registretion — Each user has to register
• Desk Availability Dashboard — See which desks are free and which are booked
• Interactive Floorplan (SVG) — Select desks visually
• Team Bookings — Book for yourself a desk
• Cancellations — Cancel your own bookings

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Ensure you have the latest version of npm installed:

• npm

  npm install npm@latest -g

Installation

Follow these steps to set up and run the project locally:

1. Clone the repo

   git clone https://github.com/eediallo/deskeando.git

2. Install NPM packages in web and api directories

   npm install

3. Configure Environment Variables

   Create a .env file with the following variables:

   DATABASE_URL=your_postgresql_database_url
   JWT_SECRET=your_jwt_secret
   PORT=3000

4. Start the Development Server

   To start both the frontend and backend concurrently in development mode, run:

   npm run dev

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are *greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

See LICENSE.txt for more information.

(back to top)