Skip to content

Commit

Permalink
cleanup readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Fleeym committed Jan 9, 2024
1 parent ff17ebd commit 9f3b103
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 21 deletions.
21 changes: 2 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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```.
3 changes: 1 addition & 2 deletions spec.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
openapi: 3.0.0
swagger: 2.0

info:
title: Geode Index
Expand Down Expand Up @@ -216,7 +215,7 @@ components:
type: object
properties:
id:
type: int
type: integer
name:
type: string
examples:
Expand Down

0 comments on commit 9f3b103

Please sign in to comment.