Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gwjun/inhagram
SNS like Instagram
https://github.com/gwjun/inhagram
instagram nestjs nextjs sns
Last synced: about 1 month ago
JSON representation
SNS like Instagram
- Host: GitHub
- URL: https://github.com/gwjun/inhagram
- Owner: GWjun
- License: mit
- Created: 2024-06-16T05:59:27.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-09-15T11:33:16.000Z (3 months ago)
- Last Synced: 2024-09-15T13:29:29.077Z (3 months ago)
- Topics: instagram, nestjs, nextjs, sns
- Language: TypeScript
- Homepage: https://inhagram.vercel.app
- Size: 2.18 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Inhagram
## Demo
[visit demo site](https://inhagram.vercel.app)
## Project Description
This project is an Instagram clone that implements the main features of Instagram. The frontend is built using Next.js and the backend is built using NestJS. There are no commercial or advertising purposes, and it is for study purposes only.
## Installation and Running
### Prerequisites
- Node.js (v14 or higher)
- pnpm
- docker
### Clone and Install
1. Clone the repository.
```bash
git clone https://github.com/GWjun/inhagram.git
cd insta-clone
```
2. Install dependencies.
```bash
pnpm install:all
```
3. (opontial) You can install frontend and backend dependencies separately.
```bash
cd frontend
pnpm install
```
```bash
cd backend
pnpm install
```
### Environment Variables
1. Create `.env.local` files in the `frontend` directory and configure them as needed.
```bash
NEXT_PUBLIC_SERVER_URL=http://localhost:8080
NEXT_PUBLIC_SERVER_DOMAIN=localhost
NEXT_PUBLIC_TOKEN_EXPIRE=your-accessToken-expire-milli-second
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=your-secret-key
```
2. Create `.env.local` files in the `backend` directory and configure them as needed.
```bash
PROTOCOL=http
HOST=localhost:8000
PORT=8080
# auth
JWT_SECRET=your-secret-key
HASH_ROUNDS=your-hash-round-value
ACCESS_EXPIRE=your-accessToken-expire-second
REFRESH_EXPIRE=your-refreshToken-expire-second
# DB
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=name
DB_PASSWORD=password
DB_DATABASE=database
# Cloud Storage
PROJECT_ID=your-id
PRIVATE_KEY=your-key
CLIENT_EMAIL=your-email
STORAGE_BUCKET=your-bucket-name
DEFAULT_AVATAR_URL=your-default-image
```
### Running the Project
1. Turn on the Docker app before starting your project to access the database.
2. To run both the frontend and backend servers simultaneously, go to the root directory and run:
```bash
pnpm start
```
3. Accessing the Application
- You can access the frontend application at http://localhost:3000.
- You can access the backend application at http://localhost:8080.
### Scripts
- `start`: Runs both frontend and backend servers concurrently.
- `start:frontend`: Runs the frontend server only.
- `start:backend`: Runs the backend server only.
## License
This project is licensed under the MIT License.