https://github.com/cihat/delaygram
full-stack instagram clone.
https://github.com/cihat/delaygram
clone-project javascript social-media typescript
Last synced: about 1 month ago
JSON representation
full-stack instagram clone.
- Host: GitHub
- URL: https://github.com/cihat/delaygram
- Owner: cihat
- License: mit
- Created: 2023-01-30T20:19:07.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T12:31:44.000Z (over 3 years ago)
- Last Synced: 2025-05-14T22:12:29.612Z (about 1 year ago)
- Topics: clone-project, javascript, social-media, typescript
- Language: TypeScript
- Homepage: https://instagram-clone-cihat.vercel.app
- Size: 993 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# stack
## Todos
**Frontend**
- [X] Change frontend framework to React/TypeScript from Vue.js
- [ ] Create React project folder structure from !research
- [ ] Create frontend structure with React
- [ ] Add state managment library(redux or zustand or other things(research)) to frontend
- [ ] a lot of things...
**Backend**
- [ ] Create UML diagram with PlantUML for backend
- [ ] Create backend RESTful API structure with Node.js/Express
- [ ] Add database(maybe mongoDB or other thing(research)) connection to backend
- [ ] Add authentication(local or google or instagram auth) to backend
- [ ] a lot of things...
---
A starter repository for MongoDB, Node.js, and React, with a local environment based on Docker.
# Installation
## Running the stack
```sh
$ docker-compose up
```
## Accessing the stack from a browser
The starter stack works with a load balancer that binds to ports 80 and 443. It currently serves the domain http://stack.localhost. In order to reach the frontend through the stack, you need to edit your `hosts` file (usually under `/etc/hosts` in UNIX environments and `C:\Windows\System32\Drivers\etc\hosts` in Windows) and add the following line:
```
127.0.0.1 stack.localhost
```
Now if you visit http://stack.localhost, you will be greeted with the frontend starter project.
## Changing the local domain
If you wish to use a domain name other than http://stack.localhost, simply set the environment variable `DOMAIN` to any domain you want.
```sh
$ DOMAIN=another-domain.localhost docker-compose up
```
You then also need to update your `hosts` file accordingly.
## Debugging
You can debug the backend while it's running in VSCode. Instead of running `docker-compose up`, run the following command:
```sh
$ docker-compose -f docker-compose.yml -f docker-compose.debug.yml up
```
This starts the backend service in the debug mode, so you can use the built-in debug task `Attach to backend` to debug your backend service.
# Running tests
## Running backend tests
```sh
$ cd backend
$ npm i
$ npm test
```
## Running frontend tests
```sh
$ cd frontend
$ npm i
$ npm test:unit
$ npm test:e2e
```
# Linting
Run `npm install` on the root folder and it will set up a pre-commit hook to lint the staged files. You will also have two lint commands, `npm run lint` and `npm run lint-staged` that you can run on the root folder.
These commands run the individual `lint` and `lint-staged` scripts in both the `frontend` and the `backend` folders, and they will respect individual configurations of these folders.
# License
MIT License
Copyright (c) 2023 Cihat Salik
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.