CAPIv2 Strapi

Overview:

The Canonn API v2 (CAPIv2) is a software application designed to handle various science projects. It is currently in active development and testing, with plans to implement multiple sites and track various data metrics. The API documentation is generated automatically and is available for different environments. The current version can be seen at the top of the readme file.

Features:

• Can handle multiple science projects and sites
• Tracks data related to regions, systems, bodies, atmosphere composition, material composition, and more
• Allows contribution from users
• Provides auto-generated Swagger documentation for different environments

Prerequisites:

• Ubuntu 20.04 LTS
• Git
• Node v12 or v14
• NPM v6
• Yarn
• Node PM2 (for running the API as a service)
• MariaDB 10.5

Step-by-step guide:

1. Install Git, Node v12, and NPM v6:

   curl -sL https://deb.nodesource.com/setup\_12.x | sudo -E bash -
   sudo apt-get install -y nodejs git build-essential libpng-dev
   

2. Install PM2 to run as a service:

   npm install -g pm2
   

3. Install Yarn for development and building:

   npm install -g yarn
   

4. Setup MariaDB:

   • Provide instructions on how to install and configure MariaDB.

5. Create Database & User for Strapi:

   • Provide instructions on how to create a database and user specifically for the Strapi application.

6. Clone the CAPIv2-Strapi project and setup:

   • Provide instructions on how to clone the project, navigate to the project directory, and install dependencies.

7. Start CAPIv2 for the first time:

   • Provide instructions on how to start the CAPIv2 application for the first time.

8. Create the Admin User:

   • Provide instructions on how to create the admin user for the Strapi application.

9. Running CAPIv2 as a service:

   • Provide instructions on how to run the CAPIv2 application as a service using PM2.

Summary:

The Canonn API v2 (CAPIv2) is a versatile software application designed to handle multiple science projects. It allows users to track various data related to regions, systems, bodies, and more. The installation process involves installing necessary dependencies, setting up the MariaDB database, cloning the project repository, and configuring the application. With its API documentation and auto-generated Swagger docs, users can easily navigate and understand how the API works.