TAMUHack – AA Challenge +  AA So you think you can fly? ✈️

AA Mock Engine

A simple backend to help you get up and running with mock data for flight data, travel info, and reservations to help you get hacking on the next big thing for AmericanAirlines.

Deploying to Heroku

Click the "Deploy to Heroku" button above to create an instance of the application in Heroku. You can use this instance for web and native app projects. After deploying, open the app and you will be redirected to the Swagger docs.

Note: if you plan to make changes to the backend, fork this repo before deploying to Heroku!

Running Locally

Dependencies

1. Run npm install to download all project devDependencies.
2. Download MongoDB and start the daemon in a separate shell with mongod --dbpath=./data.
3. Create .env file (duplicate .env.sample then rename).

Start the App

After installing all dependencies and starting the MongoDB daemon, simply run npm start to start the application.

Developing Locally

To run the app in dev, run npm run dev. This will start the app using Nodemon, which will restart the server after changes. When using this command, start the Mongo.

Mock Data

To populate the DB with mock data (users, flights, airports), either use npm run mock or navigate to SwaggerUI (/docs) and execute the /mock post request. Note: mock data population can take some time, especially if you're running in Heroku. Running npm run mock locally, from Heroku's UI, or from the Heroku CLI will let you monitor progress. If you start the process from Swagger, you can see progress by navigating to your app's dashboard and then selecting "View Logs" from the "More" dropdown.

Swagger

Starting the app will let you investigate the API via Swagger by utilizing the interactive methods found at /docs. You can examine different endpoints to see their request/response structure and retrieve/create data.

To add new endpoints or modify existing ones, use Swagger Editor (run swagger project edit from the project root) to modify api/swagger/swagger.yml. To execute commands locally, uncomment the http option under schemes. To execute commands from the Swagger Editor, uncomment the host declaration under base path.

Contributing

If you find a bug or see something you'd like to enhance, just open a PR or issue against this repo and we'll get to it as soon as we can!

Remaining Development Tasks:

• Evaluate error code validity
• Reorder endpoints in swagger file
• Create new endpoint to return MongoDB URI for connecting Mongo client remotely