Skip to content

Commit 309e529

Browse files
committed
README Update
1 parent ef3472f commit 309e529

File tree

3 files changed

+40
-6
lines changed

3 files changed

+40
-6
lines changed

README.md

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
1-
### URL Shortener
2-
* Url Shortening Service Using `NodeJS` and `Mongodb`
3-
* The Site is Hosted on `Heroku`. [Click Here](https://url-nil.herokuapp.com/)
1+
## URL Shortener
2+
* ##### URL shortner made using NodeJS and MongoDB served over Heroku. [Check here](https://url--nil.herokuapp.com/).
3+
4+
* ##### Github Repository Link [here](https://github.com/nil1729/url-shortner-nodejs).
5+
6+
---
7+
8+
### Website Preview
9+
* <img src="./preview/1.png">
10+
11+
---
12+
13+
### Setup Locally
14+
15+
##### Prerequisites
16+
17+
* [MongoDB](https://www.mongodb.com/cloud/atlas).
18+
* [Node JS](https://nodejs.org/).
19+
* [React JS](https://reactjs.org/).
20+
21+
##### Instructions
22+
23+
```
24+
>> git clone https://github.com/nil1729/url-shortner-nodejs.git
25+
>> cd url-shortner-nodejs
26+
>> npm install
27+
```
28+
##### In `config` directory
29+
* Create a `default.json` file.
30+
* Add your `MongoDB Atlas` credentials in `"mongoURI"` field.
31+
```
32+
{
33+
"mongoURI": ""
34+
}
35+
```
36+
* [Here is [the Video](https://www.youtube.com/watch?v=KKyag6t98g8) Tutorial for how to create MongoDB Atlas account and connect to NodeJS application].
37+
38+
---
39+
40+
<p style="text-align: center;">Made With<span style="color: red;"> &#10084; </span>by <a href="https://github.com/nil1729" target="_blank"> Nilanjan Deb </a> </p>

config/production.json

Lines changed: 0 additions & 3 deletions
This file was deleted.

preview/1.png

269 KB
Loading

0 commit comments

Comments
 (0)