Edit README.md

This commit is contained in:
Lucàs
2023-03-01 12:26:22 +01:00
parent b4b00d19d3
commit c42237ffcd
+42 -31
View File
@@ -1,40 +1,51 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
<h1 align="center">Welcome to Application rencontre 👋</h1>
<p>
<img alt="Version" src="https://img.shields.io/badge/version-0.1.0-blue.svg?cacheSeconds=2592000" />
<a href="https://opensource.org/license/mit/" target="_blank">
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
</a>
</p>
## Getting Started
> Application de rencontre (Projet WEB4)
First, run the development server:
### 🏠 [Homepage](indisponible pour le moment)
```bash
npm run dev
# or
yarn dev
## Installation
```sh
npm install
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Usage
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
```sh
npm run start
```
## Stack
- Next.js - A React framework with hybrid static & server rendering, and route pre-fetching, etc.
- Chakra.UI - A Simple, modular and accessible component library for React
- [Next.js](https://nextjs.org/) - Un framework React avec rendu hybride statique et serveur, préchargement de route, etc...
- [Chakra UI](https://chakra-ui.com/) - Une bibliothèque de composants simple et modulaire pour React.
[//]: # (- Three.js - 3D library for JavaScript)
## Structure du projet
```
$PROJECT_ROOT
├── pages
│ └── # Fichier de pages
├── components
│ └── # Composants React
└── public
└── # Fichiers statiques (images et modeles 3d)
```
## Auteurs
👤 **Gaël BRUGUÈS** ([@Gagl08](https://github.com/Gagl08))
👤 **Laurian DUFRECHOU** ([@Laurian-Dufrechou](https://github.com/Laurian-Dufrechou))
👤 **Lucàs VABRE** ([@LucasVbr](https://github.com/LucasVbr))
## 📝 License
Copyright © 2023 [Lucas VABRE](https://github.com/LucasVbr).<br />
Ce projet est sous licence [MIT](https://opensource.org/license/mit/).