Skip to content

Commit

Permalink
update README and spec
Browse files Browse the repository at this point in the history
  • Loading branch information
Fleeym committed Feb 22, 2024
1 parent 0a8fe92 commit 1e965d1
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Geode Server

WIP version of the new Geode Index, hosted on its own server rather than a Github repository. Uses Actix, PostgreSQL and SQLX in Rust.
The new home of the Geode Index, hosted on its own server rather than a Github repository. Uses Actix, PostgreSQL and SQLX in Rust.

The API documentation can be found [here](https://geode-sdk.github.io/server/)

## Checklist

Expand All @@ -9,14 +11,12 @@ WIP version of the new Geode Index, hosted on its own server rather than a Githu
- [x] Support for multiple developers per mod
- [x] Github OAuth
- [x] A token system for authenticating the CLI
- [ ] logo.png management
- [ ] Download counts
- [ ] External dependencies

If you want to contribute to this project, please do so! I have no bloody clue how to write a web server.
- [x] logo.png management
- [x] Download counts
- [x] External dependencies

## Required tools for development

- sqlx-cli
- PostgreSQL
- sqlx-cli (for handling migrations)
- PostgreSQL (best way to do this is just to get a docker container set up)

2 changes: 1 addition & 1 deletion openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ paths:
properties:
error:
type: "null"
token:
payload:
type: object
properties:
uuid:
Expand Down

0 comments on commit 1e965d1

Please sign in to comment.