https://github.com/mathieubesson/session-planner-pwa

https://github.com/mathieubesson/session-planner-pwa

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/mathieubesson/session-planner-pwa
• Owner: MathieuBesson
• License: mit
• Created: 2024-06-02T10:14:53.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-15T17:24:49.000Z (5 months ago)
• Last Synced: 2024-06-15T18:36:37.981Z (5 months ago)
• Language: TypeScript
• Size: 275 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Session Planner Frontend

## Description

The frontend of **Session Planner** is a web application built with **Next.js**. It serves as the user interface for interacting with the **Adonis JS** backend API to facilitate session sign-ups for Union Sportive Vernoise Badminton.

## Prerequisites

![Node.js](https://img.shields.io/badge/node.js-v18-339933?logo=nodedotjs&logoColor=white&labelColor=339933&color=white)

![npm](https://img.shields.io/badge/npm-v10-CB3837?logo=npm&logoColor=white&labelColor=CB3837&color=white)

## Installation

1. **Clone the repository**: 

   ```bash

   git clone https://github.com/MathieuBesson/session-planner-pwa

   ```

2. **Navigate to the project directory**:

   ```bash

   cd session-planner-pwa

   ```

3. **Install dependencies**:

   ```bash

   npm install

   ```

4. **Configure environment variables**:

   - Create a `.env.local` file from `.env.example` and configure the environment variables.

## Starting the development server

To start the development server, run the following command:

```bash

npm run dev

```

- The application will be accessible at: [http://localhost:3000](http://localhost:3000).

## Backend API

The **Session Planner** backend API, developed with **Adonis JS**, is available here: [session-planner-api](https://github.com/MathieuBesson/session-planner-api).

## TODO

- Review typing of all component props.

- Break down large components into smaller ones.

## License

This project is licensed under the GPL License. See the [LICENSE](./LICENSE) file for more details.