README.md

Open-Set-Go_server

This is Open-Set-Go's NestJS Server Repository! More details at Open-Set-Go Repository!

Description

Open-Set-Go_server repository is source code of Open-Set-Go's NestJS Server!
You can see more information of our topic on Open-Set-Go Repository.

This repository is not about the direction and theme of Open-Set-Go, but about where we're going to go and what improvements we're going to make to our servers!

If you want to discuss the topic, please use Discussions from Open-Set-Go!

Installation & Development Environment

Supported Environment	Version	Description
Ubuntu OS	Ubuntu 22.04	Open-Set-Go_server was developed by Ubuntu OS
Node.js	>= 18.x	@ocotokit/rest >= node v18.x
@nestjs/cli	10.1.18	Open-Set-Go_server is configured by NestJS
yarn	1.22.19	Open-Set-Go server manage package with yarn

Install with script

You can also easily install it through install.sh!

Install with docker

1. Pull our docker image!

    docker pull ymw0407/open-set-go_server
   

2. Create .env file at root to use secret environment

   See more details at EnvironmentVariable.md

3. Start Open-Set-Go Server's docker with environment variable!

Install Manually

1. Clone our Repository!

   git clone https://github.com/AgainIoT/Open-Set-Go_server.git

2. Install the Development Environment

3. Install Node Dependencies

   yarn install

4. Create .env file at root to use secret environment

   See more details at EnvironmentVariable.md

5. Start Open-Set-Go Server

     # for development
     yarn start
     yarn start:dev # Restart by detecting changes in the file!
   
     # for production
     yarn build
     node dist/main.js

API Specification

• auth module
• user module
• repo module
• mail module
• file module
  • file/license module
  • file/pr module
  • file/issue module
  • file/contributing module
  • file/readme module
• review module
  • review/file module

See more details at spec.md

Documentation

We are conducting documentation at Open-Set-Go.io. Please refer to the following. You can see our technical blog & showcase on Open-Set-Go.io

• Open-Set-Go.io

Contributing

We always welcome your contributions. Please see the CONTRIBUTING.md for how to contribute.
Also, we are recruiting collaborators, so if you are interested, please join our Slack!

Contributors

Thank you to everyone who contributed to our project.

Made with contrib.rocks

License

Open-Set-Go is released under Apache-2.0 License.
See the LICENSE file for details.