https://github.com/ahoys/roma

Project guidance system
https://github.com/ahoys/roma

Last synced: 2 months ago
JSON representation

Project guidance system

• Host: GitHub
• URL: https://github.com/ahoys/roma
• Owner: ahoys
• License: mit
• Created: 2023-07-18T09:10:35.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-02T19:46:45.000Z (over 1 year ago)
• Last Synced: 2025-02-08T12:17:03.044Z (4 months ago)
• Language: TypeScript
• Size: 1.15 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Commands

> `npm build`

Builds the production ready environment.

- Should be ran every time `.env` is altered.

> `npm start`

Starts the server in production.

- `.env` is used to read environment variables.

> `npm watch`

Starts the server in development.

- `.dev.env` is used to read environment variables.

> `npm test`

Tests the TypeScript-typings and runs Jest.

- Should be used with CI/CD.

> `npm jest`

Runs only Jest.

- To run a singular test-file, run: `npm jest `

> `npm lint`

Lints (formats) the code.

- By default you should use ESLint and Prettier extensions with VS Code.