Skip to content

VictorKengoo/Proffy-NLW2

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

80 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Proffy

Online learning platform to connect students and teachers.

web backend mobile

🌱 Project objective

O Proffy nasceu de uma iniciativa de educadores para a comunidade de desenvolvedores, como forma de proporcionar a criação de um MVP com a stack NodeJS, React e React Native (saiba mais). Esse projeto consiste em uma plataforma que liga alunos a professores particulares de diversas matérias, utilizando um sistema de crud com arquitetura de rest api no backend e com frontend's web e mobile.


🚀 Technologies

💻 Getting started

Requirements

Clone the project and access the folder

$ git clone https://github.com/VictorKengoo/Proffy-NLW2
$ cd Proffy-NLW2

Follow the steps below

Backend

# Starting from the project root folder, go to server folder
$ cd server

# Install the dependencies
$ yarn

# Use the script to run the migrations
$ yarn knex:migrate

# To finish, run the api service
$ yarn dev

# Well done, project is started!

Web

Obs.: Before to continue, be sure to have the API running

# Starting from the project root folder, go to frontend web folder
$ cd web

# Install the dependencies
$ yarn

# Be sure the file 'src/services/api.ts' have the IP to your API

# Start the client
$ yarn start

Mobile

Under development
Loading

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork VictorKengoo/Proffy-NLW2

Follow the steps below

# Clone your fork
$ git clone your-fork-url 
$ cd proffy

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.


Coded ByInstrutor

Made with 💜 by Victor Kodama

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages