https://github.com/webdiscus/playground
A code playground for all kinds of things!
https://github.com/webdiscus/playground
Last synced: 4 months ago
JSON representation
A code playground for all kinds of things!
- Host: GitHub
- URL: https://github.com/webdiscus/playground
- Owner: webdiscus
- Created: 2024-02-24T16:05:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-24T17:51:41.000Z (over 2 years ago)
- Last Synced: 2025-10-06T16:00:34.676Z (8 months ago)
- Language: SCSS
- Size: 7.47 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Camping St-Pie
Hébergement et Événementiel
## Table of Contents
- [Table of Contents](#table-of-contents)
- [How to use](#how-to-use)
- [Install](#install)
- [Lint](#lint)
- [Format](#format)
- [Test](#test)
- [Build](#build)
- [Start](#start)
- [Analyze](#analyze)
- [Commit](#commit)
- [Check](#check)
- [Development](#development)
- [Profile](#profile)
- [Structure](#structure)
## How to use
Here is the list of scripts for the project that should be used in this specific order.
### Install
- Clone the repository.
```bash
git clone https://github.com/Parapluieinfo/CampingStPie.git
```
- Install the dependencies.
```bash
npm install
```
### Lint
- Lint everything in the project
```bash
npm run lint
```
- Lint JavaScript
```bash
npm run lint:js
```
- Lint Markdown
```bash
npm run lint:markdown
```
- Lint Markup
```bash
npm run lint:markup
```
- Lint Styles
```bash
npm run lint:styles
```
- Lint YAML
```bash
npm run lint:yaml
```
### Format
- Check the formatting in the project
```bash
npm run format:check
```
- Format everything in the project
```bash
npm run format:fix
```
### Test
- TBA
### Build
- Build both client and server
```bash
npm run build
```
- Build client
```bash
npm run build:client
```
- Build server
```bash
npm run build:server
```
### Start
- Start both client and server
```bash
npm run start
```
- Start client
```bash
npm run start:client
```
- Start server
```bash
npm run start:server
```
### Analyze
- Analyze dependencies with Webpack
```bash
npm run analyze
```
### Commit
- Commit changes to the project (see [Commit Convention](./.github/COMMIT_CONVENTION.md))
```bash
npm run commit
```
### Check
- Check code before pushing to Github. **(lint, build & test)**
```bash
npm run check
```
## Development
### Profile
You can use the `NodeJS` profile in the `.vscode` directory.
1. Press `CTRL + SHIFT + P`
2. Type & Select `import profile`
3. Select `Select File...`
4. Use the file `NodeJS.code-profile` in the `.vscode` directory
5. Click the button `Create Profile`
6. Name the profile e.g. `NodeJS`
7. Press the button `Create`
### Structure
- src
- client
- files
- images
- scripts
- styles
- templates
- server