Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kainnhantumbo/url-shortner-api
Url shortner service API Node.js + Typescript + MongoDB
https://github.com/kainnhantumbo/url-shortner-api
express mongodb mongoose nodejs-api typescript
Last synced: 5 days ago
JSON representation
Url shortner service API Node.js + Typescript + MongoDB
- Host: GitHub
- URL: https://github.com/kainnhantumbo/url-shortner-api
- Owner: KainNhantumbo
- License: apache-2.0
- Created: 2022-09-29T04:45:01.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-14T22:33:21.000Z (8 months ago)
- Last Synced: 2024-03-14T23:41:07.883Z (8 months ago)
- Topics: express, mongodb, mongoose, nodejs-api, typescript
- Language: TypeScript
- Homepage:
- Size: 78.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Url Shortner REST API (Node.JS + Typescript + Mongo DB)
This web server application is built to serve its endpoints to Url Shortner application ([see it here](https://github.com/KainNhantumbo/url-shortner-app)), which is currently under development too.
### Project status
This project still under development. Further details of its bulding, software architecture and features will be given in advanced stages of development.
### Scripts for testing
Make sure you have installed **Node.js (v16.15.3 or later recommended) which also comes with npm**.\
In the project directory, you can run in terminal:
```bash
npm run dev
```
Runs the app in the development mode and the server will reload when you make changes to the source code.
```bash
npm run build
```
Builds the app for production to the **dist folder**.
```bash
npm run start
```
Builds and starts the server for prodution.
### Disclaimer
This application was made for pratice, learn and for improving my
coding skills only. Do not use this application for commercial or
professional purposes but you're free to test. Please understand that
all saved shortned urls are periodicaly deleted from the database to avoid higher server costs and that will lead them
to stop working.
## Contact
E-mail: [[email protected]]([email protected] 'Send an email')\
Github: [https://github.com/KainNhantumbo](https://github.com/KainNhantumbo 'See my github profile')
Portifolio: [https://portifolio-dev-kainnhantumbo.vercel.app](https://portifolio-dev-kainnhantumbo.vercel.app 'See my github profile')
### If you like this project, please consider leaving a star on this repository.
### With kindest regards, Kain Nhantumbo from Mozambique.
## License
Licensed under APACHE LICENSE 2.0
Copyright © 2022 Kain Nhantumbo.