victorbadaro / podcastr

PODCASTR

Summary

• 🧾 About
• 🚀 Main technologies
• 🔽 How to download the project
• 💻 How to run the project
• 👌 How to use the app
  

🧾 About

PODCASTR is a podcast application made with ReactJS and NextJS. There you can listen to the episodes listed on the screen and have all the control you would have in a music player. Some NextJS concepts were applied to this project: Server-side Rendering (SSR), Static Site Generation (SSG), API routes e File-system routes.

🚀 Main technologies

• React
• NextJS
• Typescript
• Sass
• JSON Server

(You can see all the dependencies in the package.json file)

🔽 How to download the project

$ git clone https://github.com/victorbadaro/podcastr

💻 How to run the project

The commands below use the yarn package manager.

# 1. Install all the project dependencies
$ yarn

# 2. Run JSON Server Fake API
yarn server

# You can run the project using both environments: development or production

# Development:
$ yarn dev

# To run it using the production environment you have to build the app first:
$ yarn build

# And then, you can run on terminal:
$ yarn start

If everything runs correctly, a message will be displayed on your terminal informing that the app code has been successfully compiled:

Compiled successfully

After that open your browser and access: http://localhost:3000/

✅ Nice! If you followed all the steps above correctly the project will be running locally on your machine already.

👌 How to use the app

• Choose an episode from the list and then hit its play button to start to listen to your podcast. You can also click on the episode to see the page with details about it.

---

This project was created and developed with ❤ by Victor Badaró