/happy

Bring happiness to the world

Primary LanguageTypeScriptMIT LicenseMIT

Happy

Happy | Bring happy to the world

Happy - Find places nearby and make a better day for children 💜


GitHub language count Repository size Made by marcelogaldino GitHub last commit License Stargazers

Project   |    Technologies   |    How to use   |    How to contribute   |    Backstage   |    License

Run in Insomnia}

Project

Happy is a project that helps you find the best places and start making a better day for children | Let's spread love 💜.

🚀 Technologies

This project was developed with the following technologies:

How To Use

To clone and run this application, you'll need Git (only when using Git CLI), Node.js, ReactJS installed on your computer.

From your command line:

# Clone this repository
$ git clone https://github.com/marcelogaldino/happy

Running the server

# Go into directory backend/
$ cd backend
# Install dependencies
$ npm install
# Run the backend
$ npm run dev

Creating the database

# Go into directory backend/
$ cd backend
# Create the database and run migrations
$ npm run typeorm migrate:run

Running the web

# Go into directory web/
$ cd web
# Install dependencies
$ npm install
# Run the server
$ npm start

Running the App

# Install Expo
$ npm install -g expo
# Go into directory mobile/
$ cd mobile
# Install dependencies
$ npm install
# Run the server
$ npm start

🤔 How to contribute

  • Make a fork;
  • Create a branch 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.

You are also free to help this project sending me pull requests and opening issues.

📖 Backstage

Get inside my studies and notes about this project here!

📝 License

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

Made with ♥ by Marcelo Galdino 👋 Get in touch!