Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eliasgcf/dev-radar

An application to connect developers who are close to each other - Semana OmniStack 10.0 by @rocketseat
https://github.com/eliasgcf/dev-radar

expo nodejs react-native reactjs rocketseat semana-omnistack

Last synced: 9 days ago
JSON representation

An application to connect developers who are close to each other - Semana OmniStack 10.0 by @rocketseat

Awesome Lists containing this project

README

        


DevRadar


🚀 Connect with other Devs


GitHub language count

Repository size


GitHub last commit


Repository issues


License


About the project   |   
Technologies   |   
Getting started   |   
Layout   |   
How to contribute   |   
License



Run in Insomnia


Frontend

## 💻 About the project

DevRadar it is an application to connect developers who are close to each other.

## 🚀 Technologies

Technologies that I used to develop this application

- [Node.js](https://nodejs.org/en/)
- [React](https://reactjs.org)
- [React Native](https://facebook.github.io/react-native/)
- [Expo](https://expo.io/)

## 💻 Getting started

Import the `Insomnia.json` on Insomnia App or click on [Run in Insomnia](#insomniaButton) button.

### Requirements

- [Node.js](https://nodejs.org/en/)
- [MongoDB](https://www.mongodb.com/)
- [Yarn](https://yarnpkg.com/)
- [Expo](https://expo.io/)

**Clone the project and access the folder**

```bash
$ git clone https://github.com/EliasGcf/dev-radar && cd dev-radar
```

**Install dependencies**

```bash
$ yarn
```

**Follow the steps below**

### Backend

```bash
# Edit the 'packages/server/src/index.js' and put the MongoDB URL connection

# To finish, run the api service
$ yarn server dev

# Well done, project is started!
```

### Web

_Obs.: Before to continue, be sure to have the API running_

```bash
# Be sure the file 'packages/web/src/services/api.js' have the IP to your API

# Start the client
$ yarn web start
```

### Mobile

_Obs.: Before to continue, be sure to have the API running_

```bash
# Be sure the file 'packages/mobile/src/services/api.js'
# have the IP to your API

# Run the command to start expo bundle
$ yarn mobile start

# Now choose your option to install the app
```

## 🔖 Layout

You can download the project layout on `.sketch` format [here](.github/DevRadar.sketch).

Also, it is possible use [Figma](https://figma.com) to open `.sketch` files on any operating system.

## 🤔 How to contribute

**Make a fork of this repository**

```bash
# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork EliasGcf/dev-radar
```

**Follow the steps below**

```bash
# Clone your fork
$ git clone your-fork-url && cd dev-radar

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature
```

After your pull request is merged, you can delete your branch

## 📝 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

Made with 💜  by Elias Gabriel 👋  [See my linkedin](https://www.linkedin.com/in/eliasgcf/)