Skip to content

Commit ff02a9a

Browse files
author
simcoder
committed
[Docs] Update to Readme
1 parent 528d754 commit ff02a9a

File tree

2 files changed

+96
-1
lines changed

2 files changed

+96
-1
lines changed

.vscode/settings.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"git.ignoreLimitWarning": true
3+
}

README.md

+93-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,93 @@
1-
# InstagramClone
1+
# Welcome to InstagramClone 👋
2+
![Version](https://img.shields.io/badge/version-0.1-blue.svg?cacheSeconds=2592000)
3+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
4+
[![runs with expo](https://img.shields.io/badge/Runs%20with%20Expo-000.svg?style=flat-square&logo=EXPO&labelColor=f3f3f3&logoColor=000)](https://expo.io/)
5+
[![Twitter: simcoder\_here](https://img.shields.io/twitter/follow/simcoder\_here.svg?style=social)](https://twitter.com/simcoder\_here)
6+
7+
> Main repository of the SimCoder's youtube series "Make an App like INSTAGRAM"
8+
9+
### 📺 [**Homepage**](https://www.youtube.com/watch?v=5S9HM6pprZo&list=PLxabZQCAe5fgatwOQny9wKJVs4YD6xkf1)
10+
11+
<br>
12+
13+
## ➕ Features
14+
***
15+
16+
17+
Currently the project has the following features:
18+
* expo boilerplate
19+
20+
Comming in the future:
21+
* Auth system
22+
* Post Images w/ descriptions
23+
* Take pictures directly in app
24+
* Choose from gallery
25+
* Profile page
26+
* Follow/Unfollow users
27+
* Feed in chronological order
28+
* Search Users
29+
30+
<br>
31+
32+
## 💻 Install
33+
***
34+
35+
36+
First you need to install Nodejs and npm, this is different depending on the OS you are running so it is easier to check the node [page](https://nodejs.org/en/download/)
37+
38+
Install [expo](https://expo.io/learn), if it fails run you might need to run this with sudo
39+
```sh
40+
npm install expo-cli --global
41+
```
42+
43+
Install the needed packages while in the root folder of the project
44+
```sh
45+
npm install
46+
```
47+
48+
You can check the first [video](https://www.youtube.com/watch?v=5S9HM6pprZo&t=2s) on this series to learn how to do it easily
49+
50+
<br>
51+
52+
## 📱 Usage
53+
***
54+
55+
To Start expo all you have to do is run this line
56+
```sh
57+
expo start
58+
```
59+
60+
>If you want to run on android you'll need to enable developer options and USB Debugging on your device
61+
62+
<br>
63+
64+
## 💙 question FAQ
65+
***
66+
67+
If you have any question then please use the following [Forum](https://www.simcoder.com/forum/instagram/).
68+
69+
<br>
70+
71+
## 👤 Author
72+
***
73+
74+
**SimCoder**
75+
76+
* Website: www.simcoder.com
77+
* Twitter: [@simcoder\_here](https://twitter.com/simcoder\_here)
78+
* Github: [@simcoderYoutube](https://github.com/simcoderYoutube)
79+
* Youtube: [SimCoder](https://www.youtube.com/channel/UCQ5xY26cw5Noh6poIE-VBog)
80+
81+
## 🌟 Show your support
82+
***
83+
84+
85+
Give a ⭐️ if this project helped you!
86+
87+
88+
## 📝 License
89+
***
90+
91+
Copyright © 2020 [SimCoder](https://github.com/simcoderYoutube).
92+
93+
This project is [Apache License 2.0](https://github.com/SimCoderYoutube/InstagramClone/blob/master/LICENSE) licensed. Some of the dependencies are licensed differently.

0 commit comments

Comments
 (0)