Hebtus - Frontend

This is the frontend for the Hebtus project. It is an Eventbrite clone, built with React. It is part of the coursework for the Software Engineering course at Cairo University, Faculty of Engineering.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You need to have Node.js installed on your machine, as well as npm.

Installing and Running

Clone the repository:

git clone [repo-url]

Install the dependencies:

npm install

Create a .env.staging file in the root directory of the project, and add the environment variables specified in the .env.staging.example file.

Run the project:

npm start

Running the tests

To run the tests, run the following command:

npm test

Documentation

To open the generated documentation, go to the docs directory and open the index.html file in your browser.

To generate the documentation, run the following command:

npm run docs

The repo is configured to automatically generate the documentation on every commit.

Contributers

• Khaled Mamdouh
• Marwan Mostafa
• Omar Badr
• Omar Al-Sharif