initial commit

vaibhk20 · Jun 29, 2023 · 51ed5a4 · 51ed5a4
commit 51ed5a4
Show file tree

Hide file tree

Showing 75 changed files with 66,106 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,24 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/.storybook/main.js b/.storybook/main.js
@@ -0,0 +1,16 @@
+module.exports = {
+  "stories": [
+    "../src/**/*.stories.mdx",
+    "../src/**/*.stories.@(js|jsx|ts|tsx)"
+  ],
+  "addons": [
+    "@storybook/addon-links",
+    "@storybook/addon-essentials",
+    "@storybook/addon-interactions",
+    "@storybook/preset-create-react-app"
+  ],
+  "framework": "@storybook/react",
+  "core": {
+    "builder": "@storybook/builder-webpack5"
+  }
+}
diff --git a/.storybook/preview.js b/.storybook/preview.js
@@ -0,0 +1,27 @@
+import { Provider } from "react-redux";
+import { store } from "../src/core/store";
+import { MemoryRouter } from "react-router-dom";
+export const decorators = [
+  // router
+  (Story) => (
+    <MemoryRouter initialEntries={["/"]}>
+      <Story />
+    </MemoryRouter>
+  ),
+  // redux
+  (Story) => (
+    <Provider store={store}>
+      <Story />
+    </Provider>
+  ),
+];
+
+export const parameters = {
+  actions: { argTypesRegex: "^on[A-Z].*" },
+  controls: {
+    matchers: {
+      color: /(background|color)$/i,
+      date: /Date$/,
+    },
+  },
+};
diff --git a/README.md b/README.md
@@ -0,0 +1,65 @@
+# Instagram Clone
+
+> A real time Instagram clone built using React and firebase. It is a website that allows users to create an account, login, create posts, like posts, comment on posts and update profile.
+
+## Table of contents
+
+- [Get Started](#get-started)
+- [Live Demo](#live-demo)
+- [Storybook Demo](#storybook-demo)
+- [Technologies](#technologies)
+- [Features](#features)
+- [Status](#status)
+
+# Get Started
+
+- Clone the repositroy.
+- Go to the project directory in the terminal & install the required dependencies by using:
+
+```
+npm install
+```
+
+- Type the command :
+
+```
+npm start
+```
+
+- Note - you will need to generate your own environment variables for Firebase . You can check the required variables in [.env.sample](https://github.com/Sandeep228/Instagram-Clone/blob/main/.env.sample) file.
+
+## Live Demo
+
+### [Live Demo](https://instagram-geekyants.netlify.app/)
+
+## Storybook Demo
+
+### [Storybook Demo](https://63ad3409a5d92e88c4e299ba-igrxvoqcua.chromatic.com/?path=/story/carousel--carousel-post)
+
+## Technologies
+
+- React.js
+- TypeScript
+- Storybook
+- Redux-toolkit
+- Firebase
+- Material UI
+- React router dom
+- Socket io
+- UseForm
+
+## Features
+
+- User Authentication with firebase
+- User can create a new post
+- User can like, dislike, comment to a post
+- User can follow other users
+- User can view his/her profile
+- User can view other user's profile
+- User can edit his/her profile
+- User get notification when some like or comment on her post.
+- Persistent data & file storage with Firebase
+
+## Status
+
+Project is: _in progress_
diff --git a/build-storybook.log b/build-storybook.log