https://github.com/btwld/rockets
https://github.com/btwld/rockets
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/btwld/rockets
- Owner: btwld
- License: bsd-3-clause
- Created: 2025-04-21T18:58:23.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-30T13:08:05.000Z (12 months ago)
- Last Synced: 2025-06-30T14:25:04.320Z (12 months ago)
- Language: TypeScript
- Size: 1.35 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Rockets Server
## Project
[](https://www.codacy.com/gh/conceptadev/rockets/dashboard?utm_source=github.com&utm_medium=referral&utm_content=conceptadev/rockets&utm_campaign=Badge_Grade)
[](https://codeclimate.com/github/conceptadev/rockets)
[](https://codeclimate.com/github/conceptadev/rockets)
[](https://codecov.io/gh/conceptadev/rockets)
[](https://github.com/conceptadev/rockets/actions/workflows/ci-pr-test.yml)
[](https://github.com/conceptadev/rockets)
[](https://github.com/conceptadev/rockets)
[](https://github.com/conceptadev/rockets/graphs/contributors)
```text
Rapid Enterprise Development Toolkit
```
## Overview
**Rockets Server** is a comprehensive authentication and user management
solution for NestJS applications. It provides JWT authentication, user
management, OTP verification, email notifications, and API documentation
out of the box.
## 🚀 Quick Start
### Installation
```bash
npm install @concepta/rockets-server @concepta/nestjs-typeorm-ext typeorm
```
### Basic Setup
```typescript
// app.module.ts
import { Module } from '@nestjs/common';
import { RocketsServerModule } from '@concepta/rockets-server';
import { TypeOrmExtModule } from '@concepta/nestjs-typeorm-ext';
import { UserEntity } from './entities/user.entity';
import { UserOtpEntity } from './entities/user-otp.entity';
import { FederatedEntity } from './entities/federated.entity';
@Module({
imports: [
TypeOrmExtModule.forRoot({
type: 'sqlite',
database: ':memory:',
synchronize: true,
autoLoadEntities: true,
}),
TypeOrmExtModule.forFeature({
user: { entity: UserEntity },
}),
TypeOrmExtModule.forFeature({
userOtp: { entity: UserOtpEntity },
}),
TypeOrmExtModule.forFeature({
federated: { entity: FederatedEntity },
}),
RocketsServerModule.forRoot({
jwt: {
settings: {
access: { secret: 'your-secret-key' },
refresh: { secret: 'your-refresh-secret' },
},
},
services: {
mailerService: {
sendMail: (options) => {
console.log('Email sent:', options.to);
return Promise.resolve();
},
},
},
}),
],
})
export class AppModule {}
```
That's it! You now have:
- Authentication endpoints (`/auth/login`, `/auth/signup`, etc.)
- User management (`/user`)
- OTP verification (`/otp`)
- API documentation (`/api`)
## 📖 Documentation
For detailed setup, configuration, and API reference, see:
**[📚 Complete Documentation](./packages/rockets-server/README.md)**
## 🔧 Dependencies
Rockets Server is built on top of the
[nestjs-modules](https://github.com/btwld/nestjs-modules) collection. Visit the
repository to explore individual modules for authentication, user management, email,
and more.
## 🤝 Contributing
This project is currently in alpha testing, however, feedback is highly appreciated
and encouraged!
Pull requests will be gratefully accepted in the very near future, once we have
finalized our Contributor License Agreement.
## 📄 License
This project is licensed under the MIT License - see the
[LICENSE.txt](LICENSE.txt) file for details.