3salles / happy Goto Github PK

This site was created during Next Level Week #3 powered by Rockseat.

🇺🇸English · 🇧🇷Portuguese

• About the Project
  • Layout
  • Technologies
  • Features
• Installation
  • Prerequisites
  • Front-end
    • Installing Dependencies
    • Setting Front-end
    • Running Front-end
  • Back-end
    • Installing Dependencies
    • Setting Back-end
    • Running Back-end
  • Mobile
    • Installing Dependencies
    • Running Mobile
• License
• Author

Happy is a website created in Next Level Week #3 powered by Rockeseat. This site connect people who want to visit orphanages. The application allows orphanages self register, informing opening hours, rules and location. And user can make a appointment to visit children and see the orphanages' location.

You can acess the project's layout in links below:

• Desktop
• Mobile

🚨 You need have a Figma account to acess the layout.

• TypeScript
• Node.js
• Yarn
• Express
• Mapbox
• TypeORm
• SQLite
• Axios
• Expo

• Desktop Version
• Mobile Version

This project use Node.js and Yarn, you will need them to build its dependencies.

Clone this project repository:

$ git clone https://github.com/3salles/Happy.git

#Enter in `Happy` folder:

$ cd Happy

🚨 If you don't have git in your machine, you can install it here.

In Happy folder, open web folder:

$ cd web

# And install dependencies by the following command:

$ yarn install

To use Mapbox you must have a Token acess. Create a account and take your token acess. Go to OrphanagesMap.tsx and change REACT_APP_MAPBOX_TOKEN with you token acess in the following line:

<TileLayer url={`https://api.mapbox.com/styles/v1/mapbox/outdoors-v11/tiles/256/{z}/{x}/{y}@2x?access_token=${process.env.REACT_APP_MAPBOX_TOKEN}`} />

Run the following comand to see the application:

$ yarn start

The application will be avaible on http://localhost:3000/.

🚨 Remember to start the backend!

Inside Happy folder, open backend folder:

$ cd backend

# Install dependencies woth following comand:

$ yarn install

Create database tables with following comand:

$ yarn typeorm migration:run

# If you want to drop the database tables:

$ yarn typeorm migration:revert

Run following comand to start back-end:

$ yarn dev

The Application will be avaible on http://localhost:3333/.

⚠️ Modify LOCALHOST variable address to your network address in images_views.ts archive:

    return {
      id: image.id,
      url: `http://LOCALHOST:3333/uploads/${image.path}`,
    };

This project uses Expo, install it before go to next step.

Inside Happy folder,open mobile folder:

$ cd mobile

# Install dependencies with following comand:

$ yarn install

Run mobile with following comand:

$ expo start

# If you want to use yarn:

$ yarn start

The application will open a window in your browser. If you want to use your mobile to run the application, just use the QR code. If you want to run in your desktop, read how to use Android emulator or iOS emulator.

This project uses MIT lincense.

Developed with 💜 by Beatriz Salles