Skip to content

SamipPoudel58/samiptter

Repository files navigation

samiptter preview

Samiptter | The Ultimate Social Media Site

Build status GitHub

View Demo · Report Bug · Request Feature

🌟 Features

  • Secure user registration and authentication
  • Create posts, like and comment on posts
  • Visit user profiles/follow other users
  • Search for tweets with specific keywords

⚙️ Tech Stack

  • React + Redux
  • Sass
  • Node.js
  • MongoDB

🚀 Local Development

Run the project in your machine locally.

Step 1: Clone the repository

Clone the repo locally using:

git clone https://github.com/SamipPoudel58/samiptter.git

Step 2: Install Dependencies

Install dependencies in the root folder

cd samiptter
npm install

Install dependencies in the frontend folder

cd frontend
npm install

Step 3: Setup Environment Variables

You will need to provide your own .env variables, here's how you can do it:

  • create a new file .env in the root
  • open .env.EXAMPLE
  • copy the contents and paste it into your own .env file
  • make sure you replace the values with your own valid values

Step 4: Run the server

npm run dev

🙏 Contributing

I'd love if you'd contribute to the project.

After cloning & setting up the local project you can push the changes to your github fork and make a pull request.

Pushing the changes

git add .
git commit -m "feat: added new stuff"
git push YOUR_REPO_URL BRANCH_NAME

💡 Troubleshooting

If you run into errors, try checking out fixes for some frequently occuring errors in the Troubleshooting Guide