KhanShaheb34 / Instatweet

A Twitter clone that looks like Instagram

Home Page:https://instatweet.netlify.app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Instatweet

A twitter clone that looks like instagram but does not have that many features.

Website Status Wakatime Badge

Visit instatweet.netlify.app to view the application in action!

Features

Main features of the application

  • Authentication: Sign Up, Login
  • User: Profile, Follow, Update
  • Post: Create, Delete, Like
  • Comment: Comment on Post, Delete
  • UI: Responsive, Reactive

Technologies

badge-javascriptbadge-expressbadge-sequelizebadge-postgresqlbadge-jsonwebtokens
badge-typescriptbadge-reactbadge-chakrauibadge-reduxbadge-axios
badge-dockerbadge-nginx

Run the project

You can run the project in these ways:

Docker

Build and build the docker compose file using:

docker-compose build

Now run the application by using:

docker-compose up

If you change anything in the source code, please build the docker compose file again. And please ensure that port 3000 is unallocated.

The application will start on http://localhost:3000/.

Please keep in mind that, running this project from docker, it will initialize an empty database.

Run Separately

You can run the frontend or backend separately. The process is documented in each folder.

To run the api server you'll need a postgres database. Please create on and pass it as an environment variable like:

DB_URI=postgres://username:password@host:port/dbname

If you run the backend first time in a new database please pass this environment variable:

DB_SETUP=true

This will migrate the models to the database.

Additional environment variables you can pass to the project:

JWT_SECRET=jwt_secret
PORT=port
NODE_ENV=development/production

About

A Twitter clone that looks like Instagram

https://instatweet.netlify.app/

License:MIT License


Languages

Language:TypeScript 66.7%Language:JavaScript 29.3%Language:HTML 2.6%Language:CSS 0.8%Language:Shell 0.6%