https://github.com/samnoonabrar/Documentary-ListView
A web app that will keep track of all the documentaries I have seen
https://github.com/samnoonabrar/Documentary-ListView
laravel php sql
Last synced: 9 months ago
JSON representation
A web app that will keep track of all the documentaries I have seen
- Host: GitHub
- URL: https://github.com/samnoonabrar/Documentary-ListView
- Owner: samnoon1971
- License: apache-2.0
- Created: 2023-07-19T16:27:20.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-22T16:13:26.000Z (almost 3 years ago)
- Last Synced: 2024-11-21T07:17:54.251Z (over 1 year ago)
- Topics: laravel, php, sql
- Language: PHP
- Homepage:
- Size: 187 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Documentary ListView
A web app that will keep track of all the documentaries I have seen
## Badges
[](https://opensource.org/licenses/)
[](http://www.gnu.org/licenses/agpl-3.0)
## Authors
- [@samnoon1971](https://www.github.com/samnoon1971)
## Tech Stack
**Frontend:** React, Javascript, SCSS
**Database:** PostgreSQL
**Server:** PHP, Laravel
## Contributing
Contributions are always welcome!
See `contributing.md` for ways to get started.
Please adhere to this project's `code of conduct`.
## Deployment (App and DB Services - Multi Container)
To deploy this project with `docker-compose` run
```bash
docker-compose up --build
```
## Deployment (DB Container and App on hostmachine)
To setup database, follow this steps,
Pull latest Postgresql docker image:
```bash
docker pull postgres
```
Run container with password (e.g. here it's 12345):
```bash
docker run -d --name my_pgsql -e POSTGRES_PASSWORD=12345 --network host --restart always postgres:latest
```
Setup Database tables using following commands:
```bash
php artisan migrate
php artisan db:seed
```
Now, run following commands to run App on your hostmachine:
```bash
php artisan serve
```
## Run Unit Tests
Use following command:
```bash
php artisan test
```
## Environment Variables
To run this project, you will need to add some environment variables to your .env file, see .env.example file for reference.
## Documentation
(will be added in future)
## Feedback
If you have any feedback, please reach out to us at samnoonabrar@gmail.com
## Roadmap
- Additional browser support
- Add more integrations
- Add documentation
- Add Unit Tests
- Add UI Tests
- Add E2E Tests
## Support
For support, email samnoonabrar@gmail.com or join our Slack channel.
## FAQ
#### Can I use it for commercial use?
Yes