caffeine-addictt/nexis

NYP InfoSec Auth Service

Nexis

NYP InfoSec Auth Service
Explore the docs »

Report Bug · Request Feature

About The Project

This is a auth service for NYP InfoSec.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Getting Started

This is an example of how you can set up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Python v3.9+

Installation

Below is an example of how you can install and use Nexis.

1. Install Nexis

pip install nexis

2. Run Nexis

nexis --help

Read our docs for more information.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. ( ˶ˆᗜˆ˵ )

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Read our contributing guide for more information.

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

Jun Xiang - [email protected]

(back to top)

Acknowledgments

• Repository Template
• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields

(back to top)

nexis's Issues

Merge nexis-client into nexis

Just a QOL change so that we won't have to clone 2 repositories just to work on the project.

Spec

• Makefile update
• Readme update
• Adding docs/
• Updating CI
• Adding release CI
• Update CONTRIBUTING
• Update gitignore
• Update Release drafter to ignore go files
• Moving files

Load balancing with traefik

I'll implement this when I have time

Migrate over to Golang

This is to make sure that the next batches can at least fix the code by themselves if need be.

Rust is too advanced to reliably trust that all future batches can patch issues.

Acceptance

• title and description with rust is either removed or replaced with golang
• Readme contains steps to run the project locally
• CONTRIBUTION is updated
• CODESTYLE is updated
• Existing rust code is replaced with Golang

Dockerize API

Enhancement Request

Your issue may already be reported!
Please check out our active issues before creating one.

Describe the Solution You'd Like

To limit the amount of It doesn't work on my machine issues, and to develop the server as close to the production environment as possible, running the server locally should be done through docker.

The docker image should also make use of multistaged builds to minimise memory footprint of the docker image as much as possible. To facilitate caching capabilities, Dockerfile should also be written in a way that is easily cachable (e.g. copying go.mod and downloading dependencies FIRST before copying the source code).

However, the Makefile should still expose a way to run the API without docker or hotreloading (w/ air) for developers wanting to run it locally on DOS macheines.

Checklist

• Add Dockerfile
• Dockerfile follows best practices (eg caching)
• Add docker-compose
• Docker-compose automatically exposes to host port 3000
• Test building docker in CI
• Makefile exposes script to run without docker
• Makefile exposes script to run without docker and hotreloading
• CONTRIBUTING is updated