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.

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

Adding Installation Process, Project Details, and Contributing Steps to README #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
59 changes: 57 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,62 @@

# Instagram clone using MERN stack
# Instagram Clone using MERN Stack - Frontend

This project is a clone of Instagram, built using the MERN stack, with the frontend developed using React, Redux, and Material-UI.
If you are looking for the backend repo : https://github.com/yassinjouao/instagram-clone-backend

## Project Details:
You can view a demo of this project here.

Project Structure
The frontend project is structured as follows:


' Please add the project file's structure'


## Installation
To install and run this project locally, follow these steps:



1) Clone the repository:

`git clone https://github.com/your_username/instagram-clone-frontend.git`

2) Navigate into the cloned directory

`cd instagram-clone-frontend`

3) Install the dependencies

`npm install`

4)Start the development server

`npm start
`

## Contributing
Contributions to this project are welcome. To contribute, follow these steps:

1) Fork the repository

2) Create a new branch:

`git checkout -b feature/your-feature`

3) Make your changes and commit them:

`git commit -m "Your commit message"
`

4) Push your changes to your fork

`git push origin feature/your-feature
`

5) Create a pull request in this repository

This is the frontend repo built with React. If you are looking for the backend repo : https://github.com/yassinjouao/instagram-clone-backend


## Authors
Expand Down