Molybdenum

Getting Started

Currently, the only way to get started with the project is to clone, fork or download the repository.

Requirements

The following are required to run the application in development or in production.

• Node.js >= 16.0.0
• MySQL >= 8.0.0 or a preferred SQL server such as PostgreSQL or SQLite
  TypeScript >= 4.3.5
• Yarn >= 1.22.0 or a preferred Node package manager such as npm or pnpm
• Docker >= 20.10.0 (optional)

Installation (development)

Molybdenum is built with using yarn for package management. To use other Node package manager such as npm or pnpm. Delete the yarn.lock file and run npm install or pnpm install to install the dependencies. Also, use your preferred package manager in place of yarn to execute the following commands.

1. Clone the repository and run yarn to install the dependencies.
2. Create a .env file in the root directory and populate it using the .env.example file.
3. Run yarn start to start the server.
4. Run yarn test to run the tests.
5. Run yarn run build to build the application for production.

Demo

Try out a live deployment demo of the application.

Documentation

Check out the documentation for more information.