Skip to content

Commit 628a464

Browse files
committed
feat restart project and add Factory
1 parent 0f2c9b5 commit 628a464

12 files changed

+2904
-472
lines changed

.DS_Store

6 KB
Binary file not shown.

README.md

Lines changed: 2 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Core 🧠
22

3-
> Core stuffs to your NodeJS project
3+
> The core of SecJS packages
44
55
[![GitHub followers](https://img.shields.io/github/followers/jlenon7.svg?style=social&label=Follow&maxAge=2592000)](https://github.com/jlenon7?tab=followers)
66
[![GitHub stars](https://img.shields.io/github/stars/secjs/core.svg?style=social&label=Star&maxAge=2592000)](https://github.com/secjs/core/stargazers/)
@@ -23,71 +23,15 @@ The intention behind this repository is to concentrate all `SecJS` libraries to
2323

2424
<img src=".github/core.png" width="200px" align="right" hspace="30px" vspace="100px">
2525

26-
## WARN 🛑⚠️
27-
28-
> This project is under `development` do not use it until releases v2.0.0.
29-
3026
## Installation
3127

32-
> To use the high potential from this package you need to install first this other packages from SecJS,
33-
> it keeps as dev dependency because one day `@secjs/core` will install everything once.
34-
35-
```bash
36-
npm install @secjs/utils @secjs/exceptions
37-
```
38-
3928
> Then you can install the package using:
4029
4130
```bash
4231
npm install @secjs/core
4332
```
4433

45-
## Decorators
46-
47-
### Controller
48-
49-
> Use `Controller` decorator to map a controller to your application
50-
51-
```ts
52-
import { Controller } from '@secjs/core'
53-
54-
@Controller('/tests')
55-
class TestController {}
56-
```
57-
58-
### Request Mappers - GET/POST/PUT/DELETE/ETC...
59-
60-
> Use `GET, POST, PUT, DELETE, PATCH, ALL, OPTIONS, HEAD` decorators to map the real route for your application
61-
62-
```ts
63-
import { Get, Post, Put, Delete } from '@secjs/core'
64-
65-
@Controller('/tests')
66-
class TestController {
67-
@Get()
68-
async getAll() {}
69-
70-
@Get('/:id')
71-
async getOne() {}
72-
73-
@Post()
74-
async create() {}
75-
76-
@Put(':id')
77-
async update() {}
78-
79-
@Delete('/:id')
80-
async delete() {}
81-
}
82-
83-
// Routes created:
84-
//
85-
// /tests GET
86-
// /tests/:id GET
87-
// /tests POST
88-
// /tests/:id PUT
89-
// /tests/:id DELETE
90-
```
34+
#### Under development
9135

9236
---
9337

index.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
export * from './src/Decorators/Http/Controller'
2-
export * from './src/Decorators/Http/RequestMapping'
1+
export * from './src/Factory'

0 commit comments

Comments
 (0)