Skip to content

Commit

Permalink
Revert "Update README.md"
Browse files Browse the repository at this point in the history
This reverts commit 28c0a22.
  • Loading branch information
josuapsianturi committed Mar 25, 2024
1 parent 28c0a22 commit 057684c
Showing 1 changed file with 51 additions and 34 deletions.
85 changes: 51 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,52 +51,69 @@ Package | Version
> Make sure to follow the requirements first.
Here is how you can run the project locally:
1. Clone this repo
```sh
git clone https://github.com/josuapsianturi/velflix.git
```

1. Go into the project root directory
```sh
cd velflix
```

## Step 1

Begin by cloning this repository to your machine, and installing all Composer & NPM dependencies.

```bash
git clone https://github.com/josuapsianturi/velflix.git
```

```bash
cd velflix && composer install && npm install
```

```bash
npm run build
```
1. Copy .env.example file to .env file
```sh
cp .env.example .env
```
1. Create database `velflix` (you can change database name)

1. Create account and get an API key themoviedb [ here](https://www.themoviedb.org/settings/api). Make sure to copy `API Read Access Token (v4 auth)`.

## Step 2
1. Go to `.env` file
- set database credentials (`DB_DATABASE=velflix`, `DB_USERNAME=root`, `DB_PASSWORD=`)
- paste `TMDB_TOKEN=(your API key)`
> Make sure to follow your database username and password
Make sure the configuration:
1. Install PHP dependencies
```sh
composer install
```

```bash
cp .env.example .env
```
1. Generate key
```sh
php artisan key:generate
```

1. `DB_DATABASE` - Set the database name.
2. `php artisan key:generate` - Set the application key.
1. install front-end dependencies
```sh
npm install && npm run build
```

Make sure to fill the `.env` file with the correct values.
1. Run migration
```
php artisan migrate
```

1. Run seeder
```
php artisan db:seed
```
this command will create 2 users (admin and normal user):
> email: admin@gmail.com , password: password
> email: user@gmail.com , password: password
## Step 3
1. Run server
> for valet users visit `velflix.test` in your favorite browser
```sh
php artisan serve
```

Next, get API key, run the migration, seeders, and visit the site. If using a tool like Laravel Valet, of course the URL will default to `http://velflix.test`.
1. Visit `localhost:8000` in your favorite browser.

1. Create account and get an API key themoviedb [ here](https://www.themoviedb.org/settings/api). Make sure to copy `API Read Access Token (v4 auth)`.
2. Run migration `php artisan migrate`
3. Run seeders `php artisan db:seed`
this command will create 2 users (admin and normal user):
> email: admin@gmail.com , password: password
> email: user@gmail.com , password: password
4. Visit `http://velflix.test`
> Make sure to follow your Laravel local Development Environment.
## Step 4 (Optional)
1. Newsletter feature configuration (optional)
- Go to [mailchimp](https://mailchimp.com)
- Register your account, get API key and paste it into `.env` file. If you need help, you can follow these steps:
Expand Down Expand Up @@ -129,7 +146,7 @@ Next, get API key, run the migration, seeders, and visit the site. If using a to
- open project, in .env file paste the id into `MAILCHIMP_LIST_SUBSCRIBERS=paste id here` and we ready to go
- visit `localhost:8000` or `velflix.test` test email for subscribing , and refresh your admin mailchimp it should be Your audience has increased 1 contact.

2. Setup Laravel Socialite login with Google account (optional)
14. Setup Laravel Socialite login with Google account (optional)
- Go to the [Google Developers Console](https://console.cloud.google.com/apis) get "GOOGLE_CLIENT_ID" and "GOOGLE_CLIENT_SECRET". paste it into `.env` file.
if you need help, you can follow these steps:
- Click Credentials menu, click "select a project" at the navbar > ALL > No organization > new project.
Expand Down

0 comments on commit 057684c

Please sign in to comment.