0xWryth / Projet-GL

0 stars 2 forks source link

Projet-GL

This is a Next.js project bootstrapped with create-next-app.

Actions Status

Getting Started

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

Prerequisites

Things you need to install the project :

Installing

Here are some instructions on how to get the development env running.

First, clone this repository with the following command :

git clone https://github.com/0xWryth/Projet-GL.git

Then, you must install the project's dependencies :

npm install

Development

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Database config

Before going any further, the .env file must be configured.

Next to SECRET=, specify a salt generated locally with openssl rand -base64 32 command.

SECRET=

# NEXT AUTH
NEXTAUTH_URL=http://localhost:3000

# DATABASE
DB_CONNECTION=mariadb
DB_HOST=localhost
DB_USERNAME=root
DB_PASSWORD=example
DB_DATABASE=
DB_PORT=3306
DB_SYNCHRONIZE=true
DB_LOGGING=false
ENTITIES=

You also need to complete DB_DATABASE= with the name of the database created locally (thanks to your desktop MariaDB installation or the docker container described below).

Assuming you have docker installed, execute the following command to run a MariaDB image :

npm run db

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

To learn React, check out the Create React App documentation and the React documentation.

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.


Revision history

Version 1.0.0

Project creation. Read the v1.0.0 release changelog for more information.


Built with

React TypeScript Next JS SASS

Docker MariaDB

cypress