Tindev: A tinder clone for developers 🔥

Technologies   |    Getting started   |    How to contribute   |    License

🚀 Technologies

This project was developed with the following technologies:

• Node.js
• React

Extras:

• Main Libs
  • Express
  • Mongoose ODM
• Style
  • EditorConfig
  • ESLint
  • Prettier

💺 Getting started

These instructions will get you a copy of the full project up and running on your local machine for development and testing purposes.

Setting up the development environment

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.

Cloning the project

You can obtain the project by running the instruction bellow on your terminal:

git clone https://github.com/diegomais/tindev.git

Setting up the database

The project uses MongoDB.

We recommend use Docker to install and run the database above.

1. Install Docker Desktop.
2. Start a MongoDB instance: docker run --name tindev-mongo -p 27017:27107 -d mongo

API

Adding environment variables

1. Rename the file .env.example on backend directory to .env.
2. Add the MongoDB URI (e.g. mongodb://localhost:27017/tindev) into .env file.

Installing dependencies and running the server

Run the instructions bellow inside backend directory:

1. npm install
2. npm run dev

or

1. yarn install
2. yarn dev

Web

Web application available at https://diegomais-tindev.netlify.app.

Adding environment variables

1. Rename the file .env.example on frontend directory to .env.
2. Add the API URL (e.g. http://localhost:3333) into .env file.

Installing dependencies and running the web application

Run the instructions bellow inside frontend directory:

1. npm install
2. npm start

or

1. yarn install
2. yarn start

Mobile

With an Android phone, you can load this project immediately at https://expo.io/@diegomais/tindev.

Setting up the development environment

Follow the instructions for Expo CLI available in the official React Native Documentation.

Adding environment variables

1. Rename the file environment.example.js on mobile directory to environment.js.
2. Add the API URL (e.g. http://localhost:3333) into .env file.

Installing dependencies and running the mobile application

Run the instructions bellow inside mobile directory:

1. npm install
2. expo start

or

1. yarn install
2. expo start

🤔 How to contribute

• 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.

📝 License

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

Made with ❤️ by Diego Mais 👋.