https://github.com/diegovictor/proffy-web

Project built during Rocketseat's Next Level Week #2
https://github.com/diegovictor/proffy-web

editorconfig eslint figma javascript js nextlevelweek nextlevelweek-booster nlw nlw-booster node nodejs prettier proffy react reactjs rocketseat ts typescript

Last synced: about 2 months ago
JSON representation

Project built during Rocketseat's Next Level Week #2

• Host: GitHub
• URL: https://github.com/diegovictor/proffy-web
• Owner: DiegoVictor
• License: mit
• Created: 2020-08-03T22:30:18.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-01-10T19:33:48.000Z (12 months ago)
• Last Synced: 2024-01-10T21:11:47.899Z (12 months ago)
• Topics: editorconfig, eslint, figma, javascript, js, nextlevelweek, nextlevelweek-booster, nlw, nlw-booster, node, nodejs, prettier, proffy, react, reactjs, rocketseat, ts, typescript
• Language: TypeScript
• Homepage:
• Size: 37.7 MB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [Web] Proffy

[![typescript](https://img.shields.io/badge/typescript-4.9.5-3178c6?style=flat-square&logo=typescript)](https://www.typescriptlang.org/)

[![react](https://img.shields.io/badge/reactjs-16.14.0-61dafb?style=flat-square&logo=react)](https://reactjs.org/)

[![eslint](https://img.shields.io/badge/eslint-8.34.0-4b32c3?style=flat-square&logo=eslint)](https://eslint.org/)

[![airbnb-style](https://flat.badgen.net/badge/style-guide/airbnb/ff5a5f?icon=airbnb)](https://github.com/airbnb/javascript)

[![MIT License](https://img.shields.io/badge/license-MIT-green?style=flat-square)](https://raw.githubusercontent.com/DiegoVictor/proffy-web/main/LICENSE)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

This web version allow users to register yourself, reset your password, log in, update your information, check others classes availability and share your own classes availability. All the resources used by this application comes from its [`API`](https://github.com/DiegoVictor/proffy-api).

## Table of Contents

* [Screenshots](#screenshots)

* [Installing](#installing)

* [Configuring](#configuring)

    * [.env](#env)

    * [API](#api)

* [Usage](#usage)

# Screenshots

Click to expand.
















# Installing

Easy peasy lemon squeezy:

```

$ yarn

```

Or:

```

$ npm install

```

> Was installed and configured the [`eslint`](https://eslint.org/) and [`prettier`](https://prettier.io/) to keep the code clean and patterned.

## Configuring

Configure your environment variables and remember to start the [API](https://github.com/DiegoVictor/proffy-api) before to start this app.

### .env

In this file you may configure the API's url. Rename the `.env.example` in the root directory to `.env` then just update with your settings.

key|description|default

---|---|---

REACT_APP_API_URL|API's url with version (v1)|`http://localhost:3333/v1`

### API

Start the [API](https://github.com/DiegoVictor/proffy-api) (see its README for more information). In case of any change in the API's `port` or `host` remember to update the [`.env`](#env) too.

# Usage

To start the app run:

```

$ yarn start

```

Or:

```

npm run start

```