Exam-project - VærkstedetCPH Frontend

Table of Contents

1. Project Description
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Connect to our backend repo

Project Description

This repo is the frontend part of an exam project at KEA, developed for CPH-Værkstedet.

It is a prototype of a system where users can create an account and purchase tickets that can be spend in a booking system.

The admin user for the application is seeded automatically by running the backend, and the admin panel can be accessed with the following credentials

Email: [email protected]

Password: 1234Admin

Built with

The technologies used to built this prototype are

• React.js
• Next.js
• TypeScript
• Redux Toolkit
• Chakra UI

Getting Started

To get a local copy of the project up and running, follow these steps

Prerequisites

This project requires Node.js to run

If you do not have Node.js installed, install it from their website.

This project uses Yarn as a package manage. To run the project smoothly, we recommend using yarn instead of npm.

If you do not have yarn installed, we recommend installing yarn through NPM

If you do not have npm installed, we recommend following this guide.

• Install yarn globally through npm

  npm install -g yarn

• Check the version of yarn after installation

  yarn --version

Installation

1. Clone the repository through the terminal

   git clone https://github.com/LasseStaus/frontend_chakra.git

   Alternatively you can download the zip file, and open it in your IDE.

2. Install packages used in the project

   yarn install

3. Copy the contents of .env.example into a .env file and either specify details or use the default settings

4. Run the application in production

   yarn run build

   yarn start

5. Alternatively, run the application in development mode

   yarn start:dev

back to top

Connecting to our backend

To create and connect with an instance of our backend, please go to the backend repository and follow the steps in the Readme