Skip to content

Commit f07a572

Browse files
committed
Update readme.md
1 parent 7df2f2d commit f07a572

File tree

2 files changed

+33
-109
lines changed

2 files changed

+33
-109
lines changed

.gitignore

Lines changed: 1 addition & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
<<<<<<< HEAD
21
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
32

43
# dependencies
@@ -21,110 +20,4 @@
2120

2221
npm-debug.log*
2322
yarn-debug.log*
24-
yarn-error.log*
25-
=======
26-
# Logs
27-
logs
28-
*.log
29-
npm-debug.log*
30-
yarn-debug.log*
31-
yarn-error.log*
32-
lerna-debug.log*
33-
34-
# Diagnostic reports (https://nodejs.org/api/report.html)
35-
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
36-
37-
# Runtime data
38-
pids
39-
*.pid
40-
*.seed
41-
*.pid.lock
42-
43-
# Directory for instrumented libs generated by jscoverage/JSCover
44-
lib-cov
45-
46-
# Coverage directory used by tools like istanbul
47-
coverage
48-
*.lcov
49-
50-
# nyc test coverage
51-
.nyc_output
52-
53-
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
54-
.grunt
55-
56-
# Bower dependency directory (https://bower.io/)
57-
bower_components
58-
59-
# node-waf configuration
60-
.lock-wscript
61-
62-
# Compiled binary addons (https://nodejs.org/api/addons.html)
63-
build/Release
64-
65-
# Dependency directories
66-
node_modules/
67-
jspm_packages/
68-
69-
# TypeScript v1 declaration files
70-
typings/
71-
72-
# TypeScript cache
73-
*.tsbuildinfo
74-
75-
# Optional npm cache directory
76-
.npm
77-
78-
# Optional eslint cache
79-
.eslintcache
80-
81-
# Microbundle cache
82-
.rpt2_cache/
83-
.rts2_cache_cjs/
84-
.rts2_cache_es/
85-
.rts2_cache_umd/
86-
87-
# Optional REPL history
88-
.node_repl_history
89-
90-
# Output of 'npm pack'
91-
*.tgz
92-
93-
# Yarn Integrity file
94-
.yarn-integrity
95-
96-
# dotenv environment variables file
97-
.env
98-
.env.test
99-
100-
# parcel-bundler cache (https://parceljs.org/)
101-
.cache
102-
103-
# Next.js build output
104-
.next
105-
106-
# Nuxt.js build / generate output
107-
.nuxt
108-
dist
109-
110-
# Gatsby files
111-
.cache/
112-
# Comment in the public line in if your project uses Gatsby and *not* Next.js
113-
# https://nextjs.org/blog/next-9-1#public-directory-support
114-
# public
115-
116-
# vuepress build output
117-
.vuepress/dist
118-
119-
# Serverless directories
120-
.serverless/
121-
122-
# FuseBox cache
123-
.fusebox/
124-
125-
# DynamoDB Local files
126-
.dynamodb/
127-
128-
# TernJS port file
129-
.tern-port
130-
>>>>>>> 3f50ceb2df5fe4b11d8943caecb16ba57e9de8d3
23+
yarn-error.log*

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,33 @@
11
# Keeper-App
2-
A simple react based application that is clone of google keep
2+
A simple react based application that is the clone of google keep
3+
4+
## Setup
5+
Make sure to follow all these steps exactly as explained below. Do not miss any steps or you won't be able to run this application.
6+
7+
### Clone the repositories
8+
9+
**USING HTTPS**
10+
11+
git clone https://github.com/CodeWithSouma/Keeper-App.git
12+
13+
**USING SSH**
14+
15+
git clone git@github.com:CodeWithSouma/Keeper-App.git
16+
17+
### Install the Dependencies
18+
19+
Next, from the project folder, install the dependencies:
20+
21+
npm i
22+
23+
### Start the App
24+
25+
npm start
26+
27+
This will launch the React App on port 3000. If that port is busy, you can set a different port.
28+
29+
Open up your browser and head over to:
30+
31+
http://localhost:3000/
32+
33+
You should see the home page of Kipper app. That confirms that you have set up everything successfully.

0 commit comments

Comments
 (0)