sonytruelove / place

:collision: Feel free to send a pull request or create a issue!

PLACE

EN RU CN

💥PLACE IS OPEN SOURCE FILE SHARING STORAGE

PLACE allows users to store files in the cloud, synchronize files across devices, and share files.
You can set up by yourself OR get our help
I believe that Place will become the best easily scalable storage and media trading facility.
As well as a project for training soft, design, programming skills.
Feel free to send a pull request or create a issue!

Getting started

Setup git
Clone repository
Go to back-end directory:
cd server
Rename "production.env" to ".env"(Also change data in s3 config and env if you want to work with Place)
npx prisma generate for connect env with prisma

Using Docker Compose

Setup Docker and Docker Compose

docker-compose build
docker-compose run 

Locally

Setup npm
Execute in terminal:

Setup nestjs/cli:
npm i -g @nestjs/cli
Install all dependencies:
npm i

Setup CockroachDB
Open a new terminal:
cockroach start-single-node --insecure

Setup minio
Open a new terminal:

minio server start

And finally:
npm run start:dev

Discription of Place development

Formulation of the task:

Build of a high-load easily scalable service for concluding media contracts between users, file storage and transfer.

Include a own currency, subscription

Requirements:

Front-end:

• Fast, Simple, Presentable
• Solves real problems

Source:

• Optimized
• Compliance with object-oriented programming patterns and paradigms
• Testing

Back-end:

• Stand like a million requests in one time
• Minimize failures
• Scalable architecture
• One of the servers may fail - work will continue
• All users must receive contracts

User Flow

Architecture and Tech Stack(previously)

Front-end

Next.js, Typescript, Webpack

Back-end

• Nest.js
• S3 Minio
• Cockroach DB
• JWT auth, SwaggerAPI, Typescript, Prisma, Class-validator
• Nginx, Docker, Minicube/K3s/KuberSpray

Why no cache?

• Few files to cache
• Warm-up required

Why no target audience research?

It's no start-up, so i needn't.

TODO:

• ✅ Describe a requirements
• ✅ Describe a Architecture with Tech-stack
• ✅ Introduce a server part of project
• ✅ Describe a Code-of-Conduct
• ✅ Describe User-flow
• Develop UI kit
• Develop Design system
• Introduce a front-end part of project
• Do a MVP
• ...

Changes

Remove TarantoolDB

Tarantool DB was intended for fast processing of small data and Cockroach DB for Big Data.
But the hypothesis that files can be stored in Cockroach DB was refuted. Also Prisma ORM doesn't work with Tarantool DB.

So, Cockroach DB processing all data and Tarantool DB remove from project for now.

Place is free for all contributors who want to make project better

I considered it necessary to have experience in maintain an open source project, as well as to see new ways to develop this project.

place's Issues

Add a search controller

Prisma ORM doesn't support search in CockroachDB.
Search by file/place name/url/size and etc.
Feel free to give me a solution!

Design a wireframes from user flow

Add a Placer Manage Module

According to User-flow implement the placer Manage Module.

Add a API versioning

Check CN translation of README

Fix a svg logo

If you do not follow the template, your issue will still be considered
Type: fix
Message: Sometimes I get warnings in the console about the svg logo on the client

Add a Unique place module

You need to think about how to correctly build the API so that the url looks “beautiful” (Search Engine Friendly).
A unique place must have a unique url within the user