Meetapp

Create and organize meetups about programing!

Table of Contents

• About the Project
  • Applications
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• License
• Contact

About The Project

Full-stack application to create and manage meetups about programming. This is not a flesh out product to be used in production, it is just a demo application created during Rocketseat's GoStack bootamp.

Applications

Each application has its own README. Click in the titles below for more details.

Backend

A REST API made in Node js. This is the core of the application where all the user and meetups data is managed.

Web

A SPA web application made in React JS. This is where meetups organizers goes to create and manage meetups.

Mobile

A mobile application made with React Native. This is where attendees goes to browse and subscribe to meetups. Only the android version of the app was tested. The IOs version might not work properly, so use the Android version to check out the mobile application.

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

You need these tools installed and configured to run the application in your machine.

• Node JS
• Yarn
• A Postgres SQL database
• A mailing service such as mailtrap
• Have Java and Android setup in your machine (the IOs build for the mobile application was not tested so it might not work)
• Have a real device with android connected via usb or an emulator (Genymotion is recomended)

Installation

1. Clone the repo

git clone https://github.com/Artenes/rocketseat-bootcamp-meetapp

2. Access the backend directory

cd rocketseat-bootcamp-meetapp/backend

3. Install dependencies

yarn

4. Create a copy of the .env.example file

cp .env.example .env

5. Configure the .env file (make sure to have your database running with a database created and an mailing service credentials at hand).

6. Run the migrations to create the tables. Make sure the database you set in .env exists.

yarn sequelize db:migrate

You can also run a seeder to setup some test data.

yarn sequelize db:seed:all

7. Run the server

yarn dev

8. Access the web directory

cd .. && cd web

9. Install dependencies

yarn

10. Run the app

yarn start

11. Access the mobile directory

cd .. && cd mobile

12. Install dependencies

yarn

13. Make sure you got an emulator or a device with android running.

14. Revers ports so your device can connect to the backend and Reactotron

For backend:

adb reverse tcp:3333 tcp:3333

For Reactotron:

adb reverse tcp:9090 tcp:9090

15. Run the app

yarn android

For consecutive runs just call

yarn start

In the end all 3 apps must be up and running ready to be used.

You can create an user to start using the app, but by running the seed mentioned above you can login in the app with one of these 3 emails: monique@email.com, diego@email.com or sereny@email.com. The password for them is secret.

Contributing

Contributions are welcome, even though this was made only for learning purposes.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Artenes Nogueira - artenes.nogueira@gmail.com

My blog: http://artenesbok.com/

My Linkedin: https://www.linkedin.com/in/artenes/

README template from: https://github.com/othneildrew/Best-README-Template