Meetapp
Create and organize meetups about programing!
Table of Contents
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
- Clone the repo
git clone https://github.com/Artenes/rocketseat-bootcamp-meetapp
- Access the
backend
directory
cd rocketseat-bootcamp-meetapp/backend
- Install dependencies
yarn
- Create a copy of the .env.example file
cp .env.example .env
-
Configure the .env file (make sure to have your database running with a database created and an mailing service credentials at hand).
-
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
- Run the server
yarn dev
- Access the
web
directory
cd .. && cd web
- Install dependencies
yarn
- Run the app
yarn start
- Access the
mobile
directory
cd .. && cd mobile
- Install dependencies
yarn
-
Make sure you got an emulator or a device with android running.
-
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
- 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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - 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