https://github.com/mohammedamarnah/au_courant

au cou·rant /ˌō ˈko͝oränt/ | adjective | Aware of what is going on; well informed.
https://github.com/mohammedamarnah/au_courant

Last synced: about 1 month ago
JSON representation

au cou·rant /ˌō ˈko͝oränt/ | adjective | Aware of what is going on; well informed.

• Host: GitHub
• URL: https://github.com/mohammedamarnah/au_courant
• Owner: mohammedamarnah
• License: other
• Created: 2021-11-23T16:42:58.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-04T20:30:42.000Z (about 3 years ago)
• Last Synced: 2023-03-05T02:31:20.313Z (almost 2 years ago)
• Language: JavaScript
• Size: 550 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# au_courant

au cou·rant /ˌō ˈko͝oränt/ | adjective | Aware of what is going on; well informed.

A RESTful API to keep track of and to be up-to-date on github project releases.

## Usage

----

### Get all repositories

returns all repositories' releases info that is stored in the database.

`[GET] /repos`

----

### Get a specific repository

returns a repository release info with a specific `repo-name`.

`[GET] /repos/:repo-name`

----

### Add a repository

adds a repository release info to the database.

`[POST] /add-repo`

#### Parameters

| Name | In | Type |

| ---- | -- | ---- |

| `owner` | `query` | `string` |

| `repo-name` | `query` | `string` |

----

### Remove a repository

Removes a repository release info from the database.

`[DELETE] /repos/:repo-name/delete`

----

### Update a repository

Updates a repository release info in the database.

`[PUT] /repos/:repo-name/update`

----

### Refresh all repositories

Updates all repository release information in the database and returns all repositories.

`[PUT] /refresh-repos`

----

### Mark a repository as seen

marks a repository seen state with `repo-name` as seen.

`[PUT] /mark-seen/:repo-name`

----

### Add a user 

Adds a user with a given name and password to the database. returns a JWT (JSON Web Token) for authentication.

`[POST] /add-user`

#### Parameters

| Name | In | Type |

| ---- | -- | ---- |

| `name` | `query` | `string` |

| `password` | `query` | `string` |

----

### Generate a token for a user

Generates the token associated with an existing user. Returns 403 if the user is not found.

`[GET] /generate-token`

#### Parameters

| Name | In | Type |

| ---- | -- | ---- |

| `name` | `query` | `string` |

| `password` | `query` | `string` |

## Local Development

### Clojure

Make sure [leiningen](https://leiningen.org/) is installed in your device. To run the development server:

`lein run`

You can also run the interactive REPL:

`lein repl`

This project was also built with [GraalVM](https://www.graalvm.org/) native image support. This allows for a tremendous startup speed.

To compile a native image of this project run:

`lein native` 

### PostgreSQL

The database that was used in this project is PostgreSQL. If you're on MacOS, install the [PostgreSQL app](https://postgresapp.com/).

To configure the database check `config/db_config.json`.

```json

{

  "host": "localhost",

  "user": "user",

  "password": "",

  "dbname": "database_name"

}

```

## TODO

* Handle request errors

* More on the authentication, (authenticate on every request)

* Add tests/specs

* Deployment configuration

* Add a migration generator using [babashka](https://github.com/babashka/babashka)

* ...