Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yoloftw/node-url-shortener
Node-URL-Shortener is an application written in node with a react front-end that serves as a simple url shortener.
https://github.com/yoloftw/node-url-shortener
Last synced: 27 days ago
JSON representation
Node-URL-Shortener is an application written in node with a react front-end that serves as a simple url shortener.
- Host: GitHub
- URL: https://github.com/yoloftw/node-url-shortener
- Owner: YoloFTW
- License: mit
- Created: 2023-06-21T22:46:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-19T20:28:32.000Z (over 1 year ago)
- Last Synced: 2024-10-18T14:10:39.218Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 302 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node-URL-Shortener
Node-URL-Shortener is an application written in node with a react front-end that serves as a simple url shortener. Node-URL-Shortener requires the user to fill in the .env_example file, rename it to .env, and run the Node server.
## Getting Started
To get started with the project, follow these steps:
1. Navigate to the React folder.
```shell
cd React/client
```
2. Install the dependencies.
```shell
npm install
```
3. Build the react app.
```shell
npm run build
```
4. Navigate to the Node folder.
```shell
cd ../../Node
```
5. Install the dependencies.
```shell
npm install
```
6. Fill in the necessary values in the .env_Example file.
7. Rename the .env_Example to .env
8. Start the Node server.
```shell
node .
```
9. Navigate to your webserver. The default is http://localhost:3001
### Dependencies
* Node
* npm (Node Package Manager)
* MongoDB server (A free version can be deployed [here](https://www.mongodb.com/atlas/database))
## Authors
Contributors names
* [@YoloFTW](https://github.com/YoloFTW)
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/YoloFTW/Node-URL-Shortener/blob/main/LICENSE) file for details