Layout   |    Status   |    Pre-requirements   |    Instructions   |    Tools   |    License

---

Happy is an application that connects people to orphanages for making many children's day happier 😄

---

Layout

---

Status

Project completely done! ☄️

Without mobile responsivity

Pre-requirements

Before getting started, you'll need to have installed in your machine these tools:

• Git
• Node JS

Besides that, it's a good idea to have a nice text editor like VSCode

Instructions

Running Back End (Server)

# Open the cmd/terminal and clone this repository
$ git clone <https://github.com/danielpalmares/happy>

# Open the project folder 
$ cd happy

# Go to the server folder
$ cd backend

# Install the dependencies
$ npm install

# Run the application in development mode
$ npm run dev

# The server will start

Running Front End (Client)

# Open the project folder in the cmd/terminal
$ cd happy

# Go to the client folder
$ cd web

# Install the dependencies
$ npm install

# Run the application in development mode
$ npm run start

# The server will start

Tools

These tools were used in the project:

• Node JS
• React JS
• TypeScript

License

This project is under the MIT license. See the archive LICENSE for more details.