Readme.md

Project Entry for NSU IRB

This is a project entry for the overhaul of the NSU IRB which currently handles communication and applications for research approval through email. This is also my capstone project.

Installation

• Clone Github Repo into your Go Workspace: git clone https://github.com/paingha/capstone.git
• Create .env file by renaming example.env file and filling in environment variables.
• Run docker-compose up -d
• Swagger UI is available at http://localhost:8080/swagger/index.html and API is available at http://localhost:8080/v1

Contributing

This project is currently not accepting contributions.

TODO

The following are todo items for this project

- Dockerize API, Mail Queue Service, and SMS Queue Service. - DONE

- Setup React Webapp using create-react-app. - DONE

- Use email verification html files for verification emails. - DONE

- Add more tests

- Setup Kubernetes and Docker Compose files

License

BSD License

Authors

- Paingha Joe Alagoa - 🌍 Website, 🐦 Twitter, 💼 Github