Project   |    Technologies   |    Services Used   |    Getting Started   |    How To Use   |    Features   |    Layout   |    License

💻 Project

Podcastr is an app for playing audio episodes of your favorite podcast.

🚀 Technologies

This project was developed using these techs:

• React
• Next.js
• TypeScript
• Sass
• JSON Server (Fake API)

👨‍🔧 Services Used

• GitHub
• JSON Server

🎮 Getting Started

If you want run this code, you can start cloning the repository using HTTP or SSH key.

• Open your gitBash (git terminal)

• Type git clone

• Insert the HTTP or SSH key (on windows, shift + insert to paste on gitBash)

• You can find this HTTP or SSH Key by clicking on Code on the top right in this repository

• Once cloned you can open the project in your IDE and enter the codes below in the IDE terminal

Tip: Open 2 terminals: One to start the server and the other to run the app.

yarn To add the dependencies on the project.

Option 1:

yarn server To run the fake API.

yarn dev Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

Option 2 - Using this option you can see the SSG on action:

yarn build To build the app.

yarn server To run the fake API.

yarn start Runs the app
Open http://localhost:3000 to view it in the browser.

Dependencies

• Axios
• Sass
• Date-fns
• Rc-slider

📌 How to Use

1 - When you access the project, you will see the home page. In this page you can:

1.1 - See all avaiable episodes

1.2 - Play in a episode

1.3 - Toggle shuffle episodes

1.4 - Toggle repeat episode

1.5 - Access an episode's information

2 - Episode page.

2.1 - Also here you can play episode;

2.2 - Come back to home page.

🕵 Features

The main features of the application are:

• Access an episode information
• Play an episode
• Shuffle mode
• Repeat mode
• Each episode has its own page
• SSG (Static Side Generation) and SSR (Server-side Rendering)

🔖 Layout

You can see the layout of this project through this link. It's necessary have an account on Figma to access.

📝 License

This project is under MIT license.

In case of sensitive bugs like security vulnerabilities, please contact deywerson.pereira@gmail.com directly instead of using issue tracker. We value your effort to improve the security and privacy of this project!

---

Please follow on github and join us! Thanks for visiting me and good coding!

Made with ♥ by Deywerson Pereira