Skip to content

update README #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
traumschule wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update README #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,21 @@ The "Video Check" project aims to provide a solution for video checking. It util

To install and run the project locally, please follow these steps:

1. Clone the repository: git clone https://github.com/GoldWolf115/Video-Check.git>
2. Navigate to the project directory: cd Video-Check
3. Install dependencies: npm install

## Usage

To start the server and client concurrently, use the following command:
npm run server
This command will start the server using nodemon for automatic server restarts, and the client using the npm start command.

1. Clone the repository: git clone https://github.com/Joystream/curator-video-tool
2. Navigate to the project directory: `cd curator-video-tool`
3. Install dependencies: `npm install`

## Client

`npm run dev | preview`

## Backend
The client requires an /auth server.

`cd mongo_backend`
`cp .env-example .env` # install mongo DB and adjust settings
`npm run start | server`

## Dependencies

The project relies on the following dependencies:
Expand Down Expand Up @@ -45,6 +50,6 @@ The project has the following development dependencies:

This project is licensed under the MIT license. For more information, please refer to the LICENSE file.

## Author
## Authors

This project was authored by Josh Groban
This project was authored by Josh Groban, Klaudiusz Dembler and goldwold