https://github.com/daniel-keogh/podcast-player
A podcast player application built with the MERN stack
https://github.com/daniel-keogh/podcast-player
express material-ui mern mern-stack mongodb mongoose podcast-player podcasts react reactjs
Last synced: 3 months ago
JSON representation
A podcast player application built with the MERN stack
- Host: GitHub
- URL: https://github.com/daniel-keogh/podcast-player
- Owner: daniel-keogh
- License: mit
- Created: 2019-10-27T18:29:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-12T02:44:31.000Z (over 2 years ago)
- Last Synced: 2023-03-07T06:01:47.411Z (about 2 years ago)
- Topics: express, material-ui, mern, mern-stack, mongodb, mongoose, podcast-player, podcasts, react, reactjs
- Language: TypeScript
- Homepage: https://pod-player.herokuapp.com
- Size: 5.08 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Podcast Player
[](https://github.com/daniel-keogh/podcast-player/actions/workflows/node.js.yml)
[](https://opensource.org/licenses/MIT)
A podcast player application built with the "MERN" stack, i.e. React.js, Express MongoDB, and Node.
## Installation
Run `npm install` from within the project's root to install the necessary dependencies.
## Server Setup
You'll need to create a file named `.env` with the same structure as the [`.env.example`](./backend/.env.example) file already provided in the `backend/` directory.
### MongoDB
You'll need to have MongoDB running either locally, or by entering a URL to the `MONGO_URI` key in the `.env` file.
### Redis
[Redis](https://redis.io/download) can be used for caching on the server. Once installed & added to your path, you can start the Redis server as follows.
```sh
$ redis-server
```
## Scripts
### `npm start`
Runs the React client in development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
### `npm run server`
Launches the Express server using nodemon, so it will automatically reload if you modify the server code.
### `npm run dev`
Runs the client and server concurrently.
### `npm run build`
Generates a production build of the React app inside the `build` directory.
## Build using Docker
To run using Docker Compose:
### Production
```sh
docker-compose up
```
### Development
```sh
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up
```
## Screenshots
