Skip to content
This repository has been archived by the owner on Sep 25, 2024. It is now read-only.

Latest commit

 

History

History
98 lines (65 loc) · 2.74 KB

README.md

File metadata and controls

98 lines (65 loc) · 2.74 KB

Purple Proffy Logo

Repository size GitHub last commit Stargazers


🚀 Project made to connect students to teacher

Table of contents

What is it

That's project was idealized by Rocketseat to a marathon called Next Level Week #2 where they teach, another devs and people that are getting into programming, how to use a stack of development (React JS, React Native and NodeJS).

The idea behind Proffy is to connect people that want to study to people that want to give classes, storing connections.

Technologies

  • TypeScript
  • NodeJS
  • Knex
  • Heroku
  • PostgreSQL
  • Mailer
  • Cloudinary
  • JWT
  • Front End (Another repo)

Features

  • Authentication
  • Give many classes as you want
  • Each class has it's schedule
  • User profile
  • Avatar upload
  • CRUD classes

How to run

If you want you can just live test on: proffy.baraus.dev

  • Clone the repository https://github.com/devbaraus/proffy_server
  • Get in the folder cd proffy_server
  • Install dependencies yarn install
  • Run migrations yarn knex:migrate
  • Run seedyarn knex:seed (if your want initial data and don't use if you already have stored data)
  • Set ambient variables Ambient Variables
  • Execute script yarn start

Ambient Variables

What are ambient variables

Ambient variables are variables that are stored in your machine and can be read by applications, it is useful to store secret data, like and API token, and don't want to share your data with other.

For security I used ambient variables so I could share this repository with you!

The ambient variables I used were:

CLOUDINARY - store images online

  • CLOUDINARY_API_KEY
  • CLOUDINARY_API_SECRET
  • CLOUDINARY_NAME
  • CLOUDINARY_URL

DATABASE - store user infos

  • DATABASE_URL

MAILER - send email

  • MAILER_HOST
  • MAILER_PASSWORD
  • MAILER_USER

SECRET - used to generate token

  • SECRET