https://github.com/raoul2000/tmd
Tag My Docs
https://github.com/raoul2000/tmd
document tag
Last synced: about 2 months ago
JSON representation
Tag My Docs
- Host: GitHub
- URL: https://github.com/raoul2000/tmd
- Owner: raoul2000
- Created: 2018-12-29T13:19:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-28T09:24:35.000Z (about 6 years ago)
- Last Synced: 2025-02-09T01:48:20.053Z (4 months ago)
- Topics: document, tag
- Language: TypeScript
- Size: 2.66 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tag My Doc
> Before I meet TMD, managing my documents was a nightmare. Today thanks to TMD, I feel joy in my heart and peace in my soul. TMD saved my life
>
> *(anonymous)*
## Quick Start
Get started developing...
```shell
# install deps
npm install
# run in development mode
npm run dev
# run tests
npm run test
```
`.env`file :
```
APP_ID=api-ts
PORT=3000
LOG_LEVEL=debug
REQUEST_LIMIT=100kb
SESSION_SECRET=mySecret
UPLOAD_PATH=tmp/upload
CONTENT_ROOT_PATH=tmp/content
#Swagger
SWAGGER_API_SPEC=/spec
```
---
## Install Dependencies
Install all package dependencies (one time operation)
```shell
npm install
```
## Run It
#### Run in *development* mode:
Runs the application is development mode. Should not be used in production
```shell
npm run dev
```
or debug it
```shell
npm run dev:debug
```
#### Run in *production* mode:
Compiles the application and starts it in production production mode.
```shell
npm run compile
npm start
```
## Test It
Run the Mocha unit tests
```shell
npm test
```
or debug them
```shell
npm run test:debug
```
## Try It
* Open you're browser to [http://localhost:3000](http://localhost:3000)
* Invoke the `/examples` endpoint
```shell
curl http://localhost:3000/api/v1/examples
```
## Debug It
#### Debug the server:
```
npm run dev:debug
```
#### Debug Tests
```
npm run test:debug
```
#### Debug with VSCode
Add these [contents](https://github.com/cdimascio/generator-express-no-stress/blob/next/assets/.vscode/launch.json) to your `.vscode/launch.json` file
# References
- [Project Generator : generator-express-no-stress-typescript](https://github.com/cdimascio/generator-express-no-stress-typescript)
- [OAS 2.0](https://swagger.io/specification/v2/)
- [File Upload](https://swagger.io/docs/specification/2-0/file-upload/)
- [swagger-express-middleware](https://www.npmjs.com/package/swagger-express-middleware/v/2.0.0)
# To Check
- upload widget
- https://github.com/transloadit/uppy
- https://fineuploader.com/demos.html
- https://github.com/pqina/filepond