Skip to content

Latest commit

 

History

History
56 lines (43 loc) · 1.19 KB

README.md

File metadata and controls

56 lines (43 loc) · 1.19 KB

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.
cd React/client
  1. Install the dependencies.
npm install
  1. Build the react app.
npm run build
  1. Navigate to the Node folder.
cd ../../Node
  1. Install the dependencies.
npm install
  1. Fill in the necessary values in the .env_Example file.
  2. Rename the .env_Example to .env
  3. Start the Node server.
node .
  1. 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)

Authors

Contributors names


License

This project is licensed under the MIT License - see the LICENSE file for details