aircnc: code and coffee ☕

Technologies   |    Project   |    Layout   |    Getting started   |    How to contribute   |    License

🚀 Technologies

This project was developed with the following technologies:

• Node.js
• React
• React Native

Extras:

• Main Libs
  • Express
  • Mongoose ODM
  • Next.js
  • Expo
• Style
  • EditorConfig
  • ESLint
  • Prettier

💻 Project

Aircnc is a project that aims to connect companies that want to open spots and developers looking for a place to exchange ideas with devs, get to know the company and work there for a period.

🔖 Layout

You can download the project layout in .sketch format through this link.

To open the file in .sketch format on any operating system use the tool Zeplin.

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

API and Web App

You can view this project immediately at https://diegomais-aircnc.netlify.app.

Setting up the development environment

You will need to install Git and Docker before following the instructions below.

Installation using Docker Compose

The following steps need to be performed inside a terminal window (Windows user may prefer to use the Windows Terminal but the Command Prompt will also work).

Clone the repository and build Docker images:

git clone https://github.com/diegomais/aircnc.git
cd aircnc
docker-compose build

Running the services

Use the following command to run all aircnc containers (from within the aircnc directory):

docker-compose up

You can now use the API at http://localhost:3333 and view the Web App in the browser at http://localhost:3000.

Mobile

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

Setting up the development environment

You will need to install npm or Yarn and Expo CLI before following the instructions below.

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