https://github.com/kennarddh/celosiajs-boilerplate
CelosiaJS Boilerplate
https://github.com/kennarddh/celosiajs-boilerplate
argon2 boilerplate celosiajs docker eslint express jsonwebtoken jwt nodejs typescript
Last synced: 5 months ago
JSON representation
CelosiaJS Boilerplate
- Host: GitHub
- URL: https://github.com/kennarddh/celosiajs-boilerplate
- Owner: kennarddh
- Created: 2022-02-15T03:08:55.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T21:34:20.000Z (about 1 year ago)
- Last Synced: 2025-04-12T07:03:25.638Z (about 1 year ago)
- Topics: argon2, boilerplate, celosiajs, docker, eslint, express, jsonwebtoken, jwt, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 2.3 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CelosiaJS Boilerplate
Uses [`CelosiaJS`](https://github.com/kennarddh/celosiajs) framework.
Previously `express-boilerplate`.
## Guide
### Install Dependencies
```bash
npm install
```
### Environment Variables
The environment variables can be found and modified in the `.env` file. See `.env.example` for default values.
### Project Structure
```
src/
|--Controllers/ # Controllers
|--Middlewares/ # Middlewares
|--Repositories/ # Repositories
|--Routes/ # Main routes
|--Services/ # Repositories
|--Types/ # Typescript types definition
|--Utils/ # Utility classes and functions
|--Versions/ # Versions list
| |--V{/\d+/}/ # Version (Example: V1, V2, V3)
| | |--Controllers/ # Controllers
| | |--Routes/ # Routes
|--App.ts # CelosiaJS instance
|--index.ts # Entry
```
## Available Scripts
In the project directory, you can run:
### Start Development Server
```bash
npm start
```
### Build Production
Build the project for production
```bash
npm run build
```
### Start Production
Start the built project
```bash
npm run prod
```
### Clean
Run all clean script.
```bash
npm run clean
```
### Clean Build
Removes all the files generated by the build process.
```bash
npm run clean:build
```
### Clean Logs
Removes all logs.
```bash
npm run clean:logs
```
### Lint Check
Finds linting errors.
```bash
npm run lint:check
```
### Lint Fix
Fix linting errors.
```bash
npm run lint:fix
```
### Prettier Check
Check the code formatting.
```bash
npm run prettier:check
```
### Prettier Fix
Fix the code formatting.
```bash
npm run prettier:fix
```
### Types Check
Check Typescript types.
```bash
npm run types:check
```
### Check
Check linting, code formatting, Typescript types.
```bash
npm run check
```
### Fix
Fix linting, code formatting, and check Typescript types.
```bash
npm run fix
```