Repository files navigation

All of Monki Projects'APIs specifications (including this one's) are available in themp-api-specs repository.

1. Clone the repository

   git clone https://github.com/MonkiProjects/monki-projects-api.git

2. (Recommended) IntegrateSwiftLint into your Xcode project to get warnings and errors displayed in the issue navigator

   swift package generate-xcodeprojopen monki-projects-api.xcodeproj

   FollowSwiftLint's instructions to add a new build phase

3. Setup PostgreSQL (easy way for macOS)

   This is the easiest way for macOS, you can do it differently if you prefer.

   1. Download Postgres.app atpostgresapp.com and install it.

   2. Open the sidebar (if it's not already open) by clicking on the button in the bottom-left corner.

   3. Create a new server called "Vapor" in the directory~/Library/Application Support/Postgres/vapor (you can put whatever you want at this step).

   4. ClickInitialize

   5. Once your server is running, double-click on thepostgres database to open it.

   6. Once in theSQL prompt, run

      CREATEDATABASEvapor_database;CREATEUSERvapor_username WITH PASSWORD'vapor_password';

   7. Close the shell (runexit to leave the SQL prompt if needed)

   8. You should see a new database calledvapor_database

   The config you should have can be found inconfigure.swift, but here is a recap:

   Environment variable	Value
   DATABASE_PORT	5432
   DATABASE_USERNAME	vapor_username
   DATABASE_PASSWORD	vapor_password
   DATABASE_NAME	vapor_database

   If you change these settings, you will need to add environment variables to your scheme'sRun andTest configurations.

4. Run the project

   Two possibilities:

   • OpenPackage.swift
   • Open yourmonki-projects-api.xcodeproj, go toProduct > Scheme and select theRun scheme

   From there, you will be able to run the project.

5. Stop the app

   In XCode, hit the◾ button in the top-left corner or hit⌘+. to stop the app. If you're running the app in a terminal, hitCtrl+C.

6. Stop the PostgreSQL server

   If you used Postgres.app, just open it and clickStop. Otherwise, manually stop it.

For some reason, stopping the app causes an error preventing port8080 to be closed, here is a command that kills it (tested on macOS):

lsof -t -i tcp:8080| xargskill