Ear Candy: The Audio Book You Can't Put Down
📃Table of contents:
| 1. | What is Earcandy |
| 2. | Inspiration |
| 3. | Our Tech Stack |
| 4. | Contributions |
| 6. | References |
An audiobook platform where users can create and share their own audiobooks. This platform aims to provide a space for individuals to showcase their unique voices, share their stories, and connect with like-minded individuals.
 |
|
 |
|
 |
With our user-friendly interface, users can easily upload and manage their content in parts, and connect with others through social media features such as following, liking, and commenting. Our platform provides various categories to choose from, making it simple for listeners to discover audiobooks that interest them.
- User-friendly interface
- Social media integration
- Customizable categories
- Part-by-part book upload
- Community engagement.
To begin with, first, we did User Research. Next, we created the user flow and functionality. This led us to high-fidelity design and implementation. Here is our tech stack.
- Figma for UI designing.
- Next js for frontend development.
- Typescript for development.
- Auth0 for Authentication purpose.
- Supabase for database.
- Tailwind for Styling
- Material UI for UI Components.
- To check deployment, visit this link 👉 Earcandy
This project is built on nextJS 13 experimental version
- Fork the repo into your account
- Clone the project into your local machine
git clone https://github.com/<Your-name>/Earcandy.git- Navigate the folder
cd earcandy- Install the dependencies
yarn- Make .env file in root directory with these variables
# Auth0 env
AUTH0_SECRET=<>
AUTH0_BASE_URL=http://localhost:3000
AUTH0_ISSUER_BASE_URL=<>
AUTH0_CLIENT_ID=<>
AUTH0_CLIENT_SECRET=<>
# supabase env
NEXT_PUBLIC_ANON_KEY=<>
NEXT_PUBLIC_SUPABASE_URL=<>
NEXT_PUBLIC_AUDIO_BASE_URL=https://pvvbzesrxmiuksjjhqac.supabase.co/storage/v1/object/public/audio/- Run the project on local machine
yarn dev- Every time you start making changes to your forked repo make sure it's in sync with the original repo
Thank you for considering to contribute to this project.
This project is in a very early stage so anybody who's familiar with ReactJS/NextJS/Typescript/TailwindCSS can contribute. If you don't feel ready to make a contribution yet, no problem at all. You can also contribute to this ReadMe section or the Documentation part of our project.
If you are interested to contribute and want to learn more about the technologies that are used in this project, checkout the links below.
- ReactJS Official Docs
- NextJS Documentation
- Typescript Documentaion
- TailwindCSS Docs
- Material UI Documentaion
Never made an open source contribution before? And wondering how to contribute to this project? No worries! Here's a quick guide,
- Choose any feature/bug you wish to contribute to.
- Fork the repository into your own account.
- Clone the repo you have forked in your local machine using
git clone https://github.com/<Your-name>/Earcandy.git - Create a new branch for your fix by using the command
git checkout -b YourName-branch-name - Make the changes you wish to do and stage them using the command
git add files-you-have-changedor usegit add . - Use the command
git commit -m "Short description of the changes"to describe the changes you have done with a message. - Push the changes to your remote repository using
git push origin your-branch-name - Submit a PR(pull request) to the upstream repository
Somidh/Earcandywith a title and a small description. - Wait for the pull request to be reviewed by us.
- Make appropriate changes if the maintainer recommends you to and submit it.
- Await for your contribution to be merged into the repository.
Checkout the Contributing.md file before contributing.
Give a ⭐ to the project if you liked it. :)