gbowne1 / RadioLogger

A Radio Logging application build with NodeJS and ExpressJS
GNU General Public License v3.0
6 stars 7 forks source link

[TODO] Add API documentation #76

Open gbowne1 opened 1 year ago

gbowne1 commented 1 year ago

We have little to no API documentation for our APIs and their usage.

Create documentation for our API v1 and our Web API to the /docs and our Wiki which you can clone and edit separate from the repo.

gbowne1 commented 1 year ago

If someone wants to work on reactsocialmedia https://github.com/gbowne1/reactsocialnetwork let me know.

EdwinChukwuebuka commented 1 year ago

@gbowne1 okay I'll focus on codebooker for now

jzunigarce commented 1 year ago

Hello guys, in case you have not managed to install mongo, an alternative would be to do it with docker and create a container. I execute the following line to run mongo inside a container: docker run -d --rm -p 27017:27017 --name db-mongo mongo:latest. To configure the database in the application, among other variables, an .env file is created in the src/server path with the following entries: PORT=3001 MONGO_PORT=27017 MONGO_HOST=0.0.0.0 SESSION_SECRET=test API_SECRET=SECRET The PORT variable is to configure the port where the API will be executed, if you require, you can use another port. MONGO_PORT and MONGO_HOST establish the port (you can use whatever you like) and the host (as it runs in docker the handler can leave 0.0.0.0), SESSION_SECRET AND API_SECRET are variables for the session and the api, they can add any value for purposes testing

jzunigarce commented 1 year ago

If you need, I could hold a quick meeting to explain how I configure the environment.

Chizobaonorh commented 1 year ago

If you need, I could hold a quick meeting to explain how I configure the environment.

okay i would really appreciate this, what time would be convenient?

jzunigarce commented 1 year ago

@Chizobaonorh I can after 9:00 pm GMT-7 from Monday to Friday, what time can you?

gbowne1 commented 1 year ago

@jzunigarce if you can, join the slack server https://join.slack.com/t/connectcoders/shared_invite/zt-23ajnvegn-0nUuIlxhSDU8tQrPBL~riQ