From 9f3b1039043ddc1279bb92e9ea4ce1948fa67783 Mon Sep 17 00:00:00 2001 From: Fleeym <61891787+Fleeym@users.noreply.github.com> Date: Tue, 9 Jan 2024 22:39:28 +0200 Subject: [PATCH] cleanup readme --- README.md | 21 ++------------------- spec.yml | 3 +-- 2 files changed, 3 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 9af2cd1..6630783 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Geode Server -WIP new Geode index, hosted on its own server rather than a Github repository. Uses Actix, SQLite and SQLX in Rust. +WIP version of the new Geode Index, hosted on its own server rather than a Github repository. Uses Actix, PostgreSQL and SQLX in Rust. ## Checklist @@ -12,27 +12,10 @@ WIP new Geode index, hosted on its own server rather than a Github repository. U - [ ] A token system for authenticating the CLI - [ ] Dependencies -To test, run `setup.sh` to create a test database. - If you want to contribute to this project, please do so! I have no bloody clue how to write a web server. ## Required tools for development - sqlx-cli -- SQLite - -## Setup - -> The current database engine used by the Index is SQLite. This is not permanent, we are considering a move to PostgreSQL. - -The API uses **sqlx** migrations for setting up your database. To use them in your environment, you need to install the sqlx cli with the following command: - -```cargo install sqlx-cli``` - -Make sure to create an .env file, using the example provided. Remember the path you give in DATABASE_URL. - -Make sure you have SQLite installed. To setup your database, run - -```sqlite3 db/geode-index.db < db/setup.sql``` +- PostgreSQL -After installation, you can run your migrations with ```sqlx migrate run```. diff --git a/spec.yml b/spec.yml index a330108..6161c87 100644 --- a/spec.yml +++ b/spec.yml @@ -1,5 +1,4 @@ openapi: 3.0.0 -swagger: 2.0 info: title: Geode Index @@ -216,7 +215,7 @@ components: type: object properties: id: - type: int + type: integer name: type: string examples: