ilalande / HACKATIVITE

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

HACKATIVITY - The Activity Playground

Table of Contents

  1. General information
  2. Technologies
  3. Installation
  4. Author

General information

This WebApp is a personal project

Project status and progress

Technologies

This project is written in React

Template

  • Template` : Application developed on React, Node Express from a template developed by the Wild Code School. Only the front end was used

Tools used in this template:

  • Concurrently : Allows to execute several commands in the same terminal
  • Husky : Allows to execute actions when triggered by git commands
  • Vite : Alternative to Create-React-App, with fewer packages for a smoother experience
  • ESLint : "Code quality" tool, ensures that pre-configured rules are respected
  • Prettier : "code quality" tool, also focuses on code style
  • Standard Airbnb : One of the most famous "standards", even if it is not officially linked to ES/JS
  • Nodemon : Tool to restart a server each time one of the files is modified

Other libraries

Installation

To start a project

On VSCode, install Prettier - Code formatter and ESLint plugins and configure them
Clone this repository, go inside
Run the npm run setup command

List of commands and meaning

setup : Initialization of the frontend and backend and tools
dev : Start the three servers (frontend + backend + admin) in the same terminal
dev-front : Start a React server for the frontend
lint: Run code validation tools (will be executed automatically at each commit)
fix : Fix formatting errors (to be run if lint doesn't pass)

Author

This project was developed as part of the end of the Wild Code School Javascript web developer training in June 2022 by Juliane Casier

Translated with www.DeepL.com/Translator (free version)

HACKTIVITE

About


Languages

Language:JavaScript 83.3%Language:CSS 9.3%Language:HTML 6.9%Language:Shell 0.5%