Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactored files #81

Merged
merged 11 commits into from
Oct 12, 2022
Merged

refactored files #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cc4a7de
remove unnecessary duplicate
narayan954 Oct 12, 2022
f36afe5
Delete CNAME
narayan954 Oct 12, 2022
d052b77
Add metadata to app
narayan954 Oct 12, 2022
5d03747
formatted readme
narayan954 Oct 12, 2022
05e4333
formatted components
narayan954 Oct 12, 2022
d28a5f1
remove unnecessary duplicate
narayan954 Oct 12, 2022
05f192c
Delete CNAME
narayan954 Oct 12, 2022
dc008f9
Add metadata to app
narayan954 Oct 12, 2022
fc35f5d
formatted readme
narayan954 Oct 12, 2022
0cb1bec
formatted documents
narayan954 Oct 12, 2022
c98d3c6
Merge branch 'master' into dev
narayan954 Oct 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion CNAME
View file
Open in desktop

This file was deleted.

122 changes: 13 additions & 109 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,11 @@


<div align="center">



<img src="https://user-images.githubusercontent.com/77617189/192938064-17157845-e074-45cb-bb2d-4773a8cb1602.png" alt="Dummygram" width="250" height="200">



[see live!](https://dummy-gram.web.app/)



### *Instagram*, dummified.
### *Instagram*, dummified

![Issues](https://img.shields.io/github/issues/narayan954/dummygram?color=brightgreen)
![Pull requests](https://img.shields.io/github/issues-pr/narayan954/dummygram)
Expand All @@ -22,33 +15,21 @@

---


</div>


# What is Dummygram?



## Vision



When you learn ReactJs it seems obvious to work on some projects and for the projects you might want to choose something that interests you. How about a clone of the app developed by the company that released ReactJs ? Yes, you might be getting the point, this application is basically a clone of the original Instagram and tends to add features like instagram or in fact the features that could not have been added in the instagram. So what are you waiting for? Use this opportunity to contribute and learn. :smiley:



## Status



Dummygram has been in full-time development since September 2022 and is part of GitHub since the very beginning. Our current priorities and what we are working on is kind of obvious, but still we want to give it a unique look and make it feature rich.:sparkles:



## Docs

- [How to get started with Open Source](#how-to-get-started-with-open-source)
- [How to get started with Open Source](#how-to-get-started-with-open-source)
- [Contributing](#contributing)
- [Ground Rules](#ground-rules)
- [Codebase](#codebase)
Expand All @@ -58,38 +39,23 @@ Dummygram has been in full-time development since September 2022 and is part of
- [First time setup](#first-time-setup)
- [Running the app locally](#running-the-app-locally)


## Codebase



### Technologies



With the ground rules out of the way, let's talk about the coarse architecture of this mono repo:



**Frontend JavaScript**: We use React to power our frontend apps. Almost all of the code you'll touch in this codebase will be JavaScript.
**Frontend JavaScript**: We use React to power our frontend apps. Almost all of the code you'll touch in this codebase will be JavaScript.
<img src="http://3con14.biz/code/_data/js/intro/js-logo.png" alt="JS" width="30" height="30">


Here is a list of all the big technologies we use:



- **React**: Frontend React app <img src="https://raw.githubusercontent.com/jalbertsr/logo-badge-images/master/img/react_logo.png" alt="REACT" width="35" height="35">

- **Firebase**: Data storage and Authentication <img src="https://cdn4.iconfinder.com/data/icons/google-i-o-2016/512/google_firebase-2-128.png" alt="FIREBASE" width="30" height="30">
- **React**: Frontend React app <img src="https://raw.githubusercontent.com/jalbertsr/logo-badge-images/master/img/react_logo.png" alt="REACT" width="35" height="35">



- **Firebase**: Data storage and Authentication <img src="https://cdn4.iconfinder.com/data/icons/google-i-o-2016/512/google_firebase-2-128.png" alt="FIREBASE" width="30" height="30">

### Folder structure



```sh

dummygram/
Expand All @@ -100,88 +66,56 @@ dummygram/

```



## First time setup



The first step to running dummygram locally is downloading the code by cloning the repository:



```sh

git clone git@github.com:narayan954/dummygram.git

```



If you get `Permission denied` error using `ssh` refer [here](https://help.github.com/articles/error-permission-denied-publickey/)

or use `https` link as a fallback.



```sh

git clone https://github.com/narayan954/dummygram.git

```



### Installation



Dummygram has a single installation step:

- **Install the dependencies**:


- **Install the dependencies**:

```sh

npm install

```



You've now finished installing everything! Let's start :100:



Ps: if you're getting error installing the dependancies, try --force command along with npm install. For example



```sh

npm install --force

```



Now you're ready to run the app locally and sign into your local instance!



## Running the app locally



### Start the servers



To Start the development server run `npm run dev`.



<br />

<div align="center">
Expand All @@ -191,7 +125,9 @@ To Start the development server run `npm run dev`.
</div>

## How to get started with Open Source

Here's a quick run down on how to get started with open source, first of all let's know some basic terminologies:

- Git: is a versioning system that let's you store your code and code history on your local computer preventing loses and allowing sharing of that code
- Github: is a server that let's you store the history in a database
- Open Source: A project is said to be open sourced if you can see the code on GitHub
Expand All @@ -202,94 +138,62 @@ Here's a quick run down on how to get started with open source, first of all let
- Branch: A branch is a new workspace derived from the default workspace(main or master), it allows you to work on something without affecting the original code

Now you know some basic terms, let's get into how to get started with some resources to let you understand open source better:

- [Crash Course to Git and Github](https://www.youtube.com/watch?v=apGV9Kg7ics) - Video
- [A complete Guide to Open Source](https://www.youtube.com/watch?v=yzeVMecydCE) - Video
- [Guide to Open Source](https://www.freecodecamp.org/news/how-to-contribute-to-open-source-projects-beginners-guide/) - Article


## Contributing



**We heartily welcome any and all contributions that match our engineering standards! :raised_hands:**



That being said, this codebase isn't your typical open source project because it's not a library or package with a limited scope—it's our entire product.



## Ground Rules



#### Contributions and discussion guidelines



All conversations and communities on Dummygram agree to GitHub's [Community Guidelines](https://help.github.com/en/github/site-policy/github-community-guidelines) and [Acceptable Use Policies](https://help.github.com/en/github/site-policy/github-acceptable-use-policies). This code of conduct also applies to all conversations that happen within our contributor community here on GitHub. We expect discussions in issues and pull requests to stay positive, productive, and respectful. **Remember**: There are real people on the other side of that screen:exclamation:


All conversations and communities on Dummygram agree to GitHub's [Community Guidelines](https://help.github.com/en/github/site-policy/github-community-guidelines) and [Acceptable Use Policies](https://help.github.com/en/github/site-policy/github-acceptable-use-policies). This code of conduct also applies to all conversations that happen within our contributor community here on GitHub. We expect discussions in issues and pull requests to stay positive, productive, and respectful. **Remember**: There are real people on the other side of that screen:exclamation:

#### Reporting a bug or discussing a feature idea



If you found a technical bug on Dummygram or have ideas for features we should implement, the issue tracker is the best place to share your ideas. Make sure to follow the issue template and you should be golden! ([click here to open a new issue](https://github.com/narayan954/dummygram/issues/new))



#### Fixing a bug or implementing a new feature



- If you find a bug on Dummygram and open a PR that fixes it we'll review it as soon as possible to ensure it matches our engineering standards.
- If you want to implement a new feature, open an issue first to discuss what it'd look like .
- If you want to contribute but are unsure to start, we have [a "good first issue" label](https://github.com/narayan954/dummygram/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) which is applied to newcomer-friendly issues. Take a look at [the full list of good first issues](https://github.com/narayan954/dummygram/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and pick something you like!
- Want to fix a bug or implement an agreed-upon feature? Great, jump to the [local setup instructions](#first-time-setup)!


## Rules



- **No `console.log`s in any file**: We use the `debug` module across the codebase to log debugging information in development only. Never commit a file that contains a `console.log` as CI will fail your build. The only exceptions are errors, which you can log, but you have to use `console.error` to be explicit about it


- **No `console.log`s in any file**: We use the `debug` module across the codebase to log debugging information in development only. Never commit a file that contains a `console.log` as CI will fail your build. The only exceptions are errors, which you can log, but you have to use `console.error` to be explicit about it

<div align="center">

<img height="70px" src="https://user-images.githubusercontent.com/77617189/192942891-31b9152c-918b-4fac-af05-0ad6b1f594aa.svg" />

</div>


## Open Source Programs

<a href="https://hacktoberfest.com/">
<img width="1200" alt="Email Banners-Dark" src="https://user-images.githubusercontent.com/79099734/189589410-ca17afb8-5855-4316-918a-054f27594809.png">
</a>


## Thanks to all Contributors 💪
## Thanks to all Contributors 💪

Thanks a lot for spending your time helping dummygram grow. Thanks a lot! Keep rocking 🍻

[![Contributors](https://contrib.rocks/image?repo=narayan954/dummygram)](https://github.com/narayan954/dummygram/graphs/contributors)


## GitHub



Dummygram is now part of GitHub. For code of conduct, please see [GitHub's Community Guidelines](https://help.github.com/en/github/site-policy/github-community-guidelines) and [Acceptable Use Policies](https://help.github.com/en/github/site-policy/github-acceptable-use-policies).



## License



BSD 3-Clause, see the [LICENSE](./LICENSE) file.


---
8 changes: 8 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@
<meta charset="UTF-8" />
<link rel="icon" type="image/png" href="/favicon.png" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta
name="description"
content="Instagram clone created using react and firebase"
/>
<meta
name="keywords"
content="social,social media, instagram, dummygram, clone, project, react,react project, beginner"
/>
<title>DummyGram</title>
</head>
<body>
Expand Down
39 changes: 0 additions & 39 deletions public/index.html
View file
Open in desktop

This file was deleted.

Loading