misc: update README
This commit is contained in:
parent
e6cd69f0ad
commit
5b60550f6c
1 changed files with 27 additions and 24 deletions
51
README.md
51
README.md
|
@ -1,38 +1,41 @@
|
|||
# create-svelte
|
||||
# Peer-at Code
|
||||
|
||||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
|
||||
Peer-at Code est un site web qui permet d'offrir un parcours amusant, le but étant de donner l’envie de coder et d’apprendre par le jeu.
|
||||
|
||||
## Creating a project
|
||||
## Installation
|
||||
|
||||
If you're seeing this, you've probably already done this step. Congrats!
|
||||
1. Installer [Node.js](https://nodejs.org/en/download/) (v14.15.4 ou supérieur)
|
||||
|
||||
```bash
|
||||
# create a new project in the current directory
|
||||
npm create svelte@latest
|
||||
2. Installer [pnpm](https://pnpm.io/installation)
|
||||
|
||||
# create a new project in my-app
|
||||
npm create svelte@latest my-app
|
||||
```
|
||||
3. Exécuter `pnpm install` dans le dossier du projet pour installer les dépendances
|
||||
|
||||
## Developing
|
||||
4. Exécuter `pnpm dev` pour démarrer le serveur de développement
|
||||
|
||||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
||||
Ouvre [http://localhost:5173](http://localhost:5173) avec ton navigateur pour accéder au site.
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
## Déploiement
|
||||
|
||||
# or start the server and open the app in a new browser tab
|
||||
npm run dev -- --open
|
||||
```
|
||||
1. Exécuter `pnpm build` pour générer le site
|
||||
|
||||
## Building
|
||||
2. Exécuter `node build` pour démarrer le serveur de production
|
||||
|
||||
To create a production version of your app:
|
||||
Ouvre [http://localhost:3000](http://localhost:3000) avec ton navigateur pour accéder au site.
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
## Contribution
|
||||
|
||||
You can preview the production build with `npm run preview`.
|
||||
C'est un projet open-source, donc n'hésite pas à contribuer ! Voici quelques conseils pour contribuer :
|
||||
|
||||
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
|
||||
1. Crée une branche pour tes modifications
|
||||
|
||||
2. Fais tes modifications
|
||||
|
||||
3. Crée une pull-request
|
||||
|
||||
Tu peux aussi créer une issue si tu as des questions ou des suggestions.
|
||||
|
||||
N'oublie pas de rejoindre le [serveur Discord](https://discord.gg/72vuHcwUkE) pour discuter avec nous !
|
||||
|
||||
## Licence
|
||||
|
||||
[GPU GPL V3.0](https://git.peerat.dev/Peer-at-Code/peer-at-code-web/src/branch/main/LICENSE)
|
||||
|
|
Loading…
Add table
Reference in a new issue