Einen Aufschläger erstellen

This commit is contained in:
Lordmau5 2024-05-05 00:39:19 +02:00
parent 0703b05cf5
commit 84aa14eedd
17 changed files with 6667 additions and 0 deletions

26
server/.eslintrc.js Normal file
View File

@ -0,0 +1,26 @@
module.exports = {
parser: '@typescript-eslint/parser',
parserOptions: {
project: 'tsconfig.json',
tsconfigRootDir: __dirname,
sourceType: 'module',
},
plugins: ['@typescript-eslint/eslint-plugin'],
extends: [
'plugin:@typescript-eslint/recommended',
],
root: true,
env: {
node: true,
jest: true,
},
ignorePatterns: ['.eslintrc.js'],
rules: {
'@typescript-eslint/interface-name-prefix': 'off',
'@typescript-eslint/explicit-function-return-type': 'off',
'@typescript-eslint/explicit-module-boundary-types': 'off',
'@typescript-eslint/no-explicit-any': 'off',
'indent': ['error', 'tab'],
'quotes': ['error', 'single']
},
};

59
server/.gitignore vendored Normal file
View File

@ -0,0 +1,59 @@
# compiled output
/dist
/node_modules
/build
# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
# OS
.DS_Store
# Tests
/coverage
/.nyc_output
# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace
# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
# temp directory
.temp
.tmp
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# RocksDB
database.db

73
server/README.md Normal file
View File

@ -0,0 +1,73 @@
<p align="center">
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
</p>
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
<p align="center">
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
</p>
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
## Description
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
## Installation
```bash
$ pnpm install
```
## Running the app
```bash
# development
$ pnpm run start
# watch mode
$ pnpm run start:dev
# production mode
$ pnpm run start:prod
```
## Test
```bash
# unit tests
$ pnpm run test
# e2e tests
$ pnpm run test:e2e
# test coverage
$ pnpm run test:cov
```
## Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
## Stay in touch
- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
## License
Nest is [MIT licensed](LICENSE).

8
server/nest-cli.json Normal file
View File

@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
}
}

74
server/package.json Normal file
View File

@ -0,0 +1,74 @@
{
"name": "server",
"version": "0.0.1",
"description": "",
"author": "",
"private": true,
"license": "UNLICENSED",
"scripts": {
"build": "nest build",
"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
"db": "surreal start --auth file:database.db",
"db:create": "surreal start --user root --pass root file:database.db",
"start": "nest start",
"start:dev": "nest start --watch",
"start:debug": "nest start --debug --watch",
"start:prod": "node dist/main",
"lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
"test": "jest",
"test:watch": "jest --watch",
"test:cov": "jest --coverage",
"test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
"test:e2e": "jest --config ./test/jest-e2e.json"
},
"dependencies": {
"@nestjs/common": "^10.0.0",
"@nestjs/core": "^10.0.0",
"@nestjs/platform-express": "^10.0.0",
"express": "^4.19.2",
"platform-express": "^0.0.13",
"random-word-slugs": "^0.1.7",
"reflect-metadata": "^0.2.0",
"rxjs": "^7.8.1",
"surrealdb.js": "1.0.0-beta.5"
},
"devDependencies": {
"@nestjs/cli": "^10.0.0",
"@nestjs/schematics": "^10.0.0",
"@nestjs/testing": "^10.0.0",
"@types/express": "^4.17.17",
"@types/jest": "^29.5.2",
"@types/node": "^20.3.1",
"@types/supertest": "^6.0.0",
"@typescript-eslint/eslint-plugin": "^6.0.0",
"@typescript-eslint/parser": "^6.0.0",
"eslint": "^8.42.0",
"eslint-config-prettier": "^9.0.0",
"eslint-plugin-prettier": "^5.0.0",
"jest": "^29.5.0",
"source-map-support": "^0.5.21",
"supertest": "^6.3.3",
"ts-jest": "^29.1.0",
"ts-loader": "^9.4.3",
"ts-node": "^10.9.1",
"tsconfig-paths": "^4.2.0",
"typescript": "^5.1.3"
},
"jest": {
"moduleFileExtensions": [
"js",
"json",
"ts"
],
"rootDir": "src",
"testRegex": ".*\\.spec\\.ts$",
"transform": {
"^.+\\.(t|j)s$": "ts-jest"
},
"collectCoverageFrom": [
"**/*.(t|j)s"
],
"coverageDirectory": "../coverage",
"testEnvironment": "node"
}
}

6188
server/pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

7
server/src/app.module.ts Normal file
View File

@ -0,0 +1,7 @@
import { Module } from '@nestjs/common';
import { EntriesModule } from '~/entries/entries.module';
@Module({
imports: [EntriesModule]
})
export class AppModule {}

99
server/src/db/database.ts Normal file
View File

@ -0,0 +1,99 @@
import { generateSlug } from 'random-word-slugs';
import { Surreal } from 'surrealdb.js';
import { Entry } from '~/entries/interfaces/entry.type.js';
class Database {
private readonly _db: Surreal;
constructor() {
this._db = new Surreal();
}
get db() {
return this._db;
}
async init() {
try {
// Connect to the database
await this.db.connect('ws://127.0.0.1:8000');
// Signin as a namespace, database, or root user
await this.db.signin({
username: 'root',
password: 'root',
});
// Select a specific namespace / database
await this.db.use({
namespace: 'surreal',
database: 'entries'
});
// Define stuff
await this.db.query(`
DEFINE TABLE entries SCHEMAFULL;
DEFINE FIELD slug ON TABLE entries FLEXIBLE TYPE string;
DEFINE INDEX slug_index ON TABLE entries COLUMNS slug UNIQUE;
DEFINE FIELD expires_at ON TABLE entries TYPE datetime
DEFAULT time::now() + duration::from::secs(30);
DEFINE FIELD data ON TABLE entries FLEXIBLE TYPE object
DEFAULT {};
DEFINE EVENT updated ON TABLE entries WHEN $before.data != $after.data THEN (
UPDATE entries SET expires_at = (time::now() + duration::from::secs(30)) WHERE slug = $after.slug
);
`);
}
catch (error) {
throw error;
}
}
async getEntry(slug: string): Promise<Entry> {
const [results] = await this.db.query<Entry[]>('SELECT * OMIT id FROM entries WHERE slug = $slug', { slug });
return results[0];
}
async createEntry(): Promise<Entry> {
const slug = generateSlug();
const [result] = await this.db.create<Entry>('entries', {
slug
});
delete result.id;
return result;
}
async updateEntry(slug: string, data: JSON): Promise<Entry> {
if (!await this.getEntry(slug)) {
return null;
}
await this.db.query('UPDATE entries SET data = $data WHERE slug = $slug', {
data,
slug
});
return this.getEntry(slug);
}
async deleteEntry(slug: string): Promise<boolean> {
if (!await this.getEntry(slug)) {
return false;
}
await this.db.query('DELETE FROM entries WHERE slug = $slug', {
slug
});
return true;
}
}
export default new Database();

View File

@ -0,0 +1,18 @@
import { Test, TestingModule } from '@nestjs/testing';
import { EntriesController } from './entries.controller';
describe('EntriesController', () => {
let controller: EntriesController;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
controllers: [EntriesController],
}).compile();
controller = module.get<EntriesController>(EntriesController);
});
it('should be defined', () => {
expect(controller).toBeDefined();
});
});

View File

@ -0,0 +1,28 @@
import { Body, Controller, Delete, Get, Param, Post, Put } from '@nestjs/common';
import { EntriesService } from '~/entries/entries.service';
import { Entry } from '~/entries/interfaces/entry.type';
@Controller('entries')
export class EntriesController {
constructor(private entriesService: EntriesService) {}
@Put()
async createEntry(): Promise<Entry> {
return this.entriesService.create();
}
@Get(':id')
async getEntry(@Param('id') id: string): Promise<Entry> {
return this.entriesService.getEntry(id);
}
@Post(':id')
async updateEntry(@Param('id') id: string, @Body() data: JSON): Promise<Entry> {
return this.entriesService.updateEntry(id, data);
}
@Delete(':id')
async deleteEntry(@Param('id') id: string): Promise<boolean> {
return this.entriesService.deleteEntry(id);
}
}

View File

@ -0,0 +1,9 @@
import { Module } from '@nestjs/common';
import { EntriesController } from './entries.controller';
import { EntriesService } from './entries.service';
@Module({
controllers: [EntriesController],
providers: [EntriesService],
})
export class EntriesModule {}

View File

@ -0,0 +1,22 @@
import { Injectable } from '@nestjs/common';
import { Entry } from './interfaces/entry.type';
import Database from '~/db/database';
@Injectable()
export class EntriesService {
async create(): Promise<Entry> {
return Database.createEntry();
}
async getEntry(id: string): Promise<Entry> {
return Database.getEntry(id);
}
async updateEntry(id: string, data: JSON): Promise<Entry> {
return Database.updateEntry(id, data);
}
async deleteEntry(id: string): Promise<boolean> {
return Database.deleteEntry(id);
}
}

View File

@ -0,0 +1,5 @@
export type Entry = {
slug: string;
expires_at?: Date;
data?: JSON;
};

12
server/src/main.ts Normal file
View File

@ -0,0 +1,12 @@
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { NestExpressApplication } from '@nestjs/platform-express';
import Database from '~/db/database';
async function bootstrap() {
await Database.init();
const app = await NestFactory.create<NestExpressApplication>(AppModule);
await app.listen(3000);
}
bootstrap();

View File

@ -0,0 +1,9 @@
{
"moduleFileExtensions": ["js", "json", "ts"],
"rootDir": ".",
"testEnvironment": "node",
"testRegex": ".e2e-spec.ts$",
"transform": {
"^.+\\.(t|j)s$": "ts-jest"
}
}

View File

@ -0,0 +1,4 @@
{
"extends": "./tsconfig.json",
"exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
}

26
server/tsconfig.json Normal file
View File

@ -0,0 +1,26 @@
{
"compilerOptions": {
"module": "commonjs",
"declaration": true,
"removeComments": true,
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"allowSyntheticDefaultImports": true,
"target": "ES2021",
"sourceMap": true,
"outDir": "./dist",
"baseUrl": "./",
"incremental": true,
"skipLibCheck": true,
"strictNullChecks": false,
"noImplicitAny": false,
"strictBindCallApply": false,
"forceConsistentCasingInFileNames": false,
"noFallthroughCasesInSwitch": false,
"paths": {
"~/*": [
"src/*"
],
},
}
}