-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
86 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,86 @@ | ||
| VOD! | ||
| <p align="center"> | ||
| <a href="https://github.com/polldo/govod"> | ||
| <img src="https://github.com/polldo/govod/assets/17302582/063288bc-e522-4394-af21-269e25335838" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| <h1 align="center">govod</h1> | ||
| <p align="center"><i><b>A simple web platform to sell videos on demand.</b></i></p> | ||
| <hr> | ||
|
|
||
|
|
||
| ## Features | ||
| - Login with google or password. | ||
| - Require email activation. | ||
| - Password reset. | ||
| - Free samples. | ||
| - Shopping cart. | ||
| - Purchase with stripe or paypal. | ||
| - Play videos through [VideoJS](https://github.com/videojs) (support all major streaming formats). | ||
| - Store video progress. | ||
|
|
||
| | <img src="https://github.com/polldo/govod/assets/17302582/e1f514da-24f7-4058-bfdf-a8adbfb62f33" width="300" alt=""/> Free sample demo | <img src="https://github.com/polldo/govod/assets/17302582/3c98135f-56be-4d23-a153-945cd3f88555" width="300" alt=""/> Video player demo | <img src="https://github.com/polldo/govod/assets/17302582/537cc231-330d-4983-94d0-58c03ab057bc" width="300" alt=""/> Shopping cart demo | | ||
| |-------------------|-------------------|-------------------| | ||
|
|
||
| ## Configuration | ||
| Backend: These are some environment variables you might need to set. You can find them | ||
| all in the [configuration | ||
| package](https://github.com/polldo/govod/blob/main/config/config.go). | ||
| ```bash | ||
| # Web configuration. | ||
| export GOVOD_WEB_ADDRESS="127.0.0.1:8000" | ||
| export GOVOD_AUTH_ACTIVATION_REQUIRED=true | ||
| # Database configuration. | ||
| export GOVOD_DB_USER="postgres" | ||
| export GOVOD_DB_NAME="govod" | ||
| # SMTP configuration. | ||
| export GOVOD_EMAIL_HOST="" | ||
| export GOVOD_EMAIL_PORT="" | ||
| export GOVOD_EMAIL_ADDRESS="" | ||
| export GOVOD_EMAIL_PASSWORD="" | ||
| # Paypal configuration. | ||
| export GOVOD_PAYPAL_CLIENT_ID="" | ||
| export GOVOD_PAYPAL_SECRET="" | ||
| # Stripe configuration. | ||
| export GOVOD_STRIPE_API_SECRET="" | ||
| export GOVOD_STRIPE_WEBHOOK_SECRET="" | ||
| # Google oauth configuration. | ||
| export GOVOD_OAUTH_GOOGLE_CLIENT="" | ||
| export GOVOD_OAUTH_GOOGLE_SECRET="" | ||
| export GOVOD_OAUTH_GOOGLE_URL="" | ||
| export GOVOD_OAUTH_GOOGLE_REDIRECT_URL="" | ||
| export GOVOD_OAUTH_LOGIN_REDIRECT_URL="" | ||
| # CORS configuration. | ||
| export GOVOD_CORS_ORIGIN="http://mylocal.com:3000" | ||
| ``` | ||
|
|
||
| Frontend: set these env vars in a `frontend/.env.local` file: | ||
| ```bash | ||
| NEXT_PUBLIC_PAYPAL_CLIENT_ID="" | ||
| NEXT_PUBLIC_BASE_URL="http://mylocal.com:8000" | ||
| ``` | ||
|
|
||
|
|
||
| ## Build and run | ||
| This project uses PostgreSQL, so you need it to run the backend. | ||
|
|
||
| You'll also need to run the [db migrations](https://github.com/polldo/govod/tree/main/database/sql/migration). | ||
|
|
||
| Then, to correctly integrate stripe and paypal, you need to make an account and | ||
| fill the environment variables accordingly. | ||
|
|
||
| For the SMTP server you can use a dedicated service like Mailtrap. | ||
|
|
||
| To run the backend - assuming your env variables are defined in a .env file: | ||
| ```bash | ||
| cd cmd/server | ||
| . ./.env | ||
| go run . | ||
| ``` | ||
|
|
||
| To run the frontend: | ||
| ```bash | ||
| cd frontend | ||
| npm run dev | ||
| ``` | ||
|
|