Technologies | Getting started | How to contribute | License
This project was developed with the following technologies:
Extras:
- Main Libs
- Style
These instructions will get you a copy of the full project up and running on your local machine for development and testing purposes.
The project is developed using Git. Git is a free and open source distributed version control system. Download Git.
The project can be built with npm or Yarn, so choose one of the approach bellow in case you don't have any installed on your system.
- npm is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer. Download Node.js.
- Yarn is a package manager built by Facebook Team and seems to be faster than npm in general. Download Yarn.
You can obtain the project by running the instruction bellow on your terminal:
git clone https://github.com/diegomais/tindev.git
The project uses MongoDB.
We recommend use Docker to install and run the database above.
- Install Docker Desktop.
- Start a MongoDB instance:
docker run --name tindev-mongo -p 27017:27107 -d mongo
- Rename the file
.env.example
onpackages/api
directory to.env
. - Add the MongoDB URI (e.g.
mongodb://localhost:27017/tindev
) into.env
file.
Run the instructions bellow inside packages/api
directory:
npm install
npm run dev
or
yarn install
yarn dev
Web application available at https://diegomais-tindev.netlify.app.
- Rename the file
.env.example
onpackages/web
directory to.env
. - Add the API URL (e.g.
http://localhost:3333
) into.env
file.
Run the instructions bellow inside packages/web
directory:
npm install
npm start
or
yarn install
yarn start
With an Android phone, you can load this project immediately at https://expo.io/@diegomais/tindev.
Follow the instructions for Expo CLI available in the official React Native Documentation.
- Rename the file
environment.example.js
onpackages/mobile
directory toenvironment.js
. - Add the API URL (e.g.
http://localhost:3333
) into.env
file.
Run the instructions bellow inside packages/mobile
directory:
npm install
expo start
or
yarn install
expo start
- Fork this repository;
- Create a branch with your feature:
git checkout -b my-feature
; - Commit your changes:
git commit -m '[feat](scope) My new feature'
; - Push to your branch:
git push origin my-feature
.
After the merge of your pull request is done, you can delete your branch.
This project is under the MIT license. See the LICENSE for more details.
Made with ❤️ by Diego Mais 👋.