Happy is a project developed from the International Children's Day that takes place on October 12th.
The goal is to create an application where you can find and visit orphanages.
This project was developed with the following technologies:
This project depends on happy-platform-server to work correctly.
To clone and run this application, you'll need Git and Node.js installed on your computer.
From your command line:
# Clone this repository
$ git clone https://github.com/joeldorosarioo/happy-platform.git
$ cd happy-platform
# Install dependencies
$ yarn install
# Activate hooks
$ yarn husky install
# Start the Server
$ yarn start
The project requires setting the following environment variable:
REACT_APP_MAPBOX_ACCESS_TOKEN
: This environment variable is required to access Mapbox features. Make sure you get a valid access token from Mapbox and set it to the value of this environment variable.
Follow the steps below to properly configure environment variables in your development environment:
- Create an
.env
file in the root of the project. - Open the
.env
file and set the necessary environment variables. In the case of this project, add the following line:
REACT_APP_MAPBOX_ACCESS_TOKEN=<your_token>
Be sure to replace <your_token>
with the actual access token provided by Mapbox.
- Save the
.env
file.
Note: The .env file is usually added to the .gitignore file to prevent environment keys from being publicly shared.
- Make a fork;
- Create a branck with your feature:
git checkout -b my-feature
; - Commit changes:
git commit -m 'feat: My new feature'
; - Make a push to your branch:
git push origin my-feature
.
After merging your receipt request to done, you can delete a branch from yours.
This project is under the MIT license. See the LICENSE for details.