My Planner Web

Table of content

• Table of content
• Project board
• Installation
• Start
• Main available scripts
• Main libraries and tools
• Changelog

Project

My Planner is composed by an API and a WEB projects.

You can check the project's progress in Trello board.

Installation

To install the application, you'll need Git and Node.js v16. From your command line:

# Clone this repository
$ git clone https://github.com/Jullymac/my-planner-web.git

# Go into the repository
$ cd my-planner-web

# Install dependencies
$ npm install

Start

You can start the application locally with the following command:

$ npm run dev

It will run at http://localhost:3000

Main Available Scripts

npm run dev: Runs the app in the development mode.

npm run test: Launches the test runner in the interactive watch mode.

npm run build: Builds the app for production to the build folder.

npm run start: Runs the build in production mode.

npm run lint: Runs prettier and eslint.

Main Libraries and tools

The main libraries and frameworks used in this project are:

• ReactJs - v18.2
• Typescript - v4.7
• Prettier - v2.7.1
• EsLint - v8.21.0
• Husky - v8.0

Changelog

For a full list of changes, see Changelog