The official backend framework for the astaroid platform, written in svelte-kit, deployed to netlify and used supabase for database(postgres database), authentication and storage.

• Astaroid-backend
  • Installation
  • Environmental variables
  • Database
    • Tables
      • users
      • assets
      • market
      • notifications
    • Functions
    • Triggers
  • Storage
  • Api docs
    • Available constants
      • ASC-PRICE
      • DESC-PRICE
      • ASC-RAREST
      • DESC-RAREST
      • SOLD_ASSET_MESSAGE
      • BOUGHT_CRYSTAL_MESSAGE
    • Available types
      • Crystal
      • Asset
      • User
      • UserAuth
      • UserProfileImage
      • CrystalBought
      • AssetSold
      • MergeAsset
      • NotificationMetadata
      • Notification
    • Available methods
      • POST - market
      • GET - market
      • POST - signup
      • POST - signin
      • POST - confirm-email
      • POST - magic-link
      • GET - user
      • POST - user
      • DELETE - user
      • POST - profile-image
      • GET - asset
      • POST - buy
      • POST - merge
      • POST - sell
      • POST - merge
      • GET - notification
      • POST - notification
      • DELETE - notification
  • Api error messages
  • License

To install astaroid-backend, first clone the repo

git clone https://github.com/astaroid/backend.git

or download the compressed file here.

Secondly install all required dependencies with npm install (or pnpm install or yarn install).

Astaroid-backend required some important environmental variables to function properly.

Set all the Environmental variable in .env file at the astaroid-backend root directory.

Astaroid-backend require the following postgres database tables.

The users table require the following columns.

The assets table require the following columns.

The market table require the following columns.

The notifications table require the following columns.

Astaroid-backend require the following postgres functions.

Astaroid-backend require the following postgres triggers.

Astaroid-backend requires a public supabase storage bucket, profile-image to store the user profile picture.

All queries to the Astaroid-backend need to be presented in this form: [PROTOCOL]://[HOST]/api/[METHOD_NAME]?api_key=API_KEY.

http://localhost:3000/api/market?api_key=[API_KEY]

Astaroid-backend support GET, POST and DELETE HTTP methods. We support two ways of passing parameters in requests:

• URL query string
• application/json

The response contains a JSON object, which always has a Boolean field ok and the Object fields data and error. If ok equals True, the request was successful and the result of the request can be found in the data field. In case of an unsuccessful request, ok equals false and the error is found in error field, which is a JSON object containing the error message and code.

• All methods in the Astaroid-backend API are case-insensitive.
• All queries must be made using UTF-8.

Arrange crystal by price in ascending order.

Arrange crystal by price in descending order.

Arrange crystal by rarest rate in ascending order.

Arrange crystal by rarest rate in descending order.

Notification message sent when a user sell an asset.

Notification message sent when a user buy a crystal.

Representation of a crystal in the market.

Representation of a user asset(crystal bought by the user).

Representation of a user.

Representation of a user profile image.

Representation of a crystal bought by a user.

Representation of an asset sold by a user.

Representation of a merged asset.

Representation of a user notification message metadata.

Representation of a user notification message.

All methods in the Astaroid-backend API are case-insensitive and support GET, POST and DELETE HTTP methods. Use either URL query string or application/json for passing parameters in Astaroid-backend API requests. On successful call, a JSON object containing a Boolean field ok and a Object field data, while the error Object field is null.

The request must have POST as it HTTP method.

Use to create a crystal. no data is return even if the request is successful.

Syntax

[PROTOCOL]://[HOST]/api/market?admin_key=[ADMIN_KEY]

Example

http://localhost:3000/api/market?admin_key=[ADMIN_KEY]

The request must have GET as it HTTP method.

Use to get all crystals. On success an Array of Crystal is returned.

Syntax

[PROTOCOL]://[HOST]/api/market?api_key=[API_KEY]&color=[COLOR]&price=[PRICE]&rarest=[RAREST]&order=[ORDER]

Example

http://localhost:3000/api/market?api_key=[API_KEY]&color=green,red,yellow&price=10,20,40&rarest=40&order=ASC-PRICE

The request must have POST as it HTTP method.

Use to sign up a user. On success UserAuth is returned.

Syntax

[PROTOCOL]://[HOST]/api/auth/signup?api_key=[API_KEY]

Remainding parameters(expect api_key) are passed in the body of the request with the header content-type of application/json.

Example

http://localhost:3000/api/auth/signup?api_key=[API_KEY]

Request body

{
 "username": "user1234",
 "email": "[email protected]",
 "password": "secret_1223"
}

The request must have POST as it HTTP method.

Use to sign in a user. On success UserAuth is returned.

Syntax

[PROTOCOL]://[HOST]/api/auth/signin?api_key=[API_KEY]

Remaining parameters(expect api_key) are passed in the body of the request with the header content-type of application/json.

Example

http://localhost:3000/api/auth/signin?api_key=[API_KEY]

Request body

{
 "usernameOrEmail": "[email protected]",
 "password": "secret_1223"
}

The request must have POST as it HTTP method.

Use to send a user a confirmation email. no data is return even if the request is successful.

Syntax

[PROTOCOL]://[HOST]/api/auth/confirm-email?api_key=[API_KEY]&user_id=[USER_ID]

Example

http://localhost:3000/api/auth/confirm-email?api_key=[API_KEY]&user_id=[USER_ID]

The request must have POST as it HTTP method.

Use to send a magic link to a user email. no data is return even if the request is successful.

Syntax

[PROTOCOL]://[HOST]/api/auth/magic-link?api_key=[API_KEY]&email=[EMAIL]

Example

http://localhost:3000/api/auth/magic-link?api_key=[API_KEY]&[email protected]

The request must have GET as it HTTP method.

Use to get data about a user. On success User is returned.

Syntax

[PROTOCOL]://[HOST]/api/user/[USER_ID]?api_key=[API_KEY]

[USER_ID] placeholder represent the unique identification of the user the method is carried out on.

Example

http://localhost:3000/api/user/[USER_ID]?api_key=[API_KEY]

The request must have POST as it HTTP method.

Use to edit the user data. On success User is returned. On failure with error code 201, 202, 203 User is stilled returned and the error.

Syntax

[PROTOCOL]://[HOST]/api/user/[USER_ID]?api_key=[API_KEY]

[USER_ID] placeholder represent the unique identification of the user the method is carried out on.

Remaining parameters(expect api_key) are passed in the body of the request with the header content-type of application/json.

Example

http://localhost:3000/api/user/[USER_ID]?api_key=[API_KEY]

Request body

{
 "password": "BORdaBKGgo12345",
 "email": "[email protected]"
}

The request must have DELETE as it HTTP method.

Use to delete a data. no data is return even if the request is successful.

Syntax

[PROTOCOL]://[HOST]/api/user/[USER_ID]?api_key=[API_KEY]

[USER_ID] placeholder represent the unique identification of the user the method is carried out on.

Example

http://localhost:3000/api/user/[USER_ID]?api_key=[API_KEY]

The request must have POST as it HTTP method.

Use to upload a user profile image. On success UserProfileImage is returned.

Syntax

[PROTOCOL]://[HOST]/api/user/[USER_ID]/profile-image?api_key=[API_KEY]

[USER_ID] placeholder represent the unique identification of the user the method is carried out on.

Remaining parameters(expect api_key) are passed in the body of the request with the header content-type of application/json.

Example

http://localhost:3000/api/user/[USER_ID]/profile-image?api_key=[API_KEY]

Request body

{
 "data": "iVBORw0KGgoAAAANSUhEUgAAAvo......",
 "type": "image/png"
}

The request must have GET as it HTTP method.

Use to get the user assets. On success an Array of Asset is returned.

Syntax

[PROTOCOL]://[HOST]/api/user/[USER_ID]/asset?api_key=[API_KEY]&color=[COLOR]

[USER_ID] placeholder represent the unique identification of the user the method is carried out on.

Example

http://localhost:3000/api/user/[USER_ID]/asset?api_key=[API_KEY]&color=red,blue

The request must have POST as it HTTP method.

Use to buy a crystal. On success CrystalBought is returned.

Syntax

[PROTOCOL]://[HOST]/api/user/[USER_ID]/asset/buy?api_key=[API_KEY]&crystal_id=[CRYSTAL_ID]&bought_at=[BOUGHT_AT]

[USER_ID] placeholder represent the unique identification of the user the method is carried out on.

Example

http://localhost:3000/api/user/[USER_ID]/asset/buy?api_key=[API_KEY]&crystal_id=[CRYSTAL_ID]&bought_at=2022-08-10T12:48:08.14908722+01:00[Africa/Lagos]

The request must have POST as it HTTP method.

Use to merge a user assets together. On success MergeAsset is returned.

Syntax

[PROTOCOL]://[HOST]/api/user/[USER_ID]/asset/merge?api_key=[API_KEY]&assets=[ASSETS]&created_at=[CREATED_AT]

[USER_ID] placeholder represent the unique identification of the user the method is carried out on.

Example

http://localhost:3000/api/user/[USER_ID]/asset/merge?api_key=[API_KEY]&assets=red,blue&created_at=2022-08-10T12:48:08.14908722+01:00[Africa/Lagos]

The request must have POST as it HTTP method.

Use to sell a user asset. On success AssetSold is returned.

Syntax

[PROTOCOL]://[HOST]/api/user/[USER_ID]/asset/sell?api_key=[API_KEY]&asset_id=[ASSET_ID]&sold_at =[SOLD_AT]

[USER_ID] placeholder represent the unique identification of the user the method is carried out on.

Example

http://localhost:3000/api/user/[USER_ID]/asset/sell?api_key=[API_KEY]&asset_id=[ASSET_ID]&sold_at=2022-08-10T12:48:08.14908722+01:00[Africa/Lagos]

The request must have GET as it HTTP method.

Use to get all the user notifications. On success Array of Notification is returned.

Syntax

[PROTOCOL]://[HOST]/api/user/[USER_ID]/notification?api_key=[API_KEY]

[USER_ID] placeholder represent the unique identification of the user the method is carried out on.

Example

http://localhost:3000/api/user/[USER_ID]/notification?api_key=[API_KEY]

The request must have POST as it HTTP method.

Use to set a user notification to read or not. On success Notification is returned.

Syntax

[PROTOCOL]://[HOST]/api/user/[USER_ID]/notification?api_key=[API_KEY]&notification_id=[NOTIFICATION_ID]&read=[READ]

[USER_ID] placeholder represent the unique identification of the user the method is carried out on.

Example

http://localhost:3000/api/user/[USER_ID]/notification?api_key=[API_KEY]&notification_id=[NOTIFICATION_ID]&read=true

The request must have DELETE as it HTTP method.

Use to delete a user notification. On success Notification is returned.

Syntax

[PROTOCOL]://[HOST]/api/user/[USER_ID]/notification?api_key=[API_KEY]&notification_id=[NOTIFICATION_ID]

[USER_ID] placeholder represent the unique identification of the user the method is carried out on.

Example

http://localhost:3000/api/user/[USER_ID]/notification?api_key=[API_KEY]&notification_id=[NOTIFICATION_ID]

Astaroid-backend return the following error messages when there is a bad request from the client.

MIT