GithubHelp home page GithubHelp logo

haryelramalho / nlw2-proffy Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 575 KB

Proffy is a website developed with a technique called "mobile-first". Developed at RocketSeat Next Level Week #2.

License: MIT License

TypeScript 75.49% JavaScript 0.19% HTML 0.84% CSS 23.49%

nlw2-proffy's Introduction

Proffy

An online study plataform that promises to connect students to teachers in any area of knowledge

Made by Repository size GitHub last commit GitHub

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

Run in Insomnia

Proffy

🧸 About the project

This project was developed on the Next Level Week #02 event by Rocketseat 🚀 💜

Happy is an application that connects people to institutional care homes to make many children's day happier

🚀 Technologies

Technologies that I used to develop this application

💻 Getting started

Import the Insomnia.json on Insomnia App or click on Run in Insomnia button

Requirements

$ git clone https://github.com/haryelramalho/nlw2-proffy.git && cd nlw2-proffy

Follow the steps below

Backend

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

# Install the dependencies
$ yarn

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

# To finish, run the api service
$ yarn start

# 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 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

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

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

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

# Start the expo service and scan the QR code with Expo Client
$ yarn start

🤔 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 haryelramalho/nlw2-proffy

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd nlw2-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.


Made with 💜  by Haryel 👋  See my linkedin

nlw2-proffy's People

Contributors

haryelramalho avatar

Stargazers

Roman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.