README.md

Welcome to Spotifyre 👋

Spotifyre is a Spotify application that acts as a Playlist Manager for curators. Our app focuses on making playlist collaboration and song sharing between listeners and curators super easy.

✨ Use the App Here!

🏠 Homepage

Install & Usage Locally

yarn install
yarn run dev

Server

cd server
yarn install && yarn dev

Local Postgres Setup

Make sure docker is setup on your machine first

In the project root, run:

docker-compose --env-file ./server/.env.local up -d

To connect to database:

psql spotifyre -h localhost -U postgres
# When prompted for password, enter "postgres"

If postgres tools are not installed on your machine:

docker container ls # find the container for spotifyre_db and copy its id
docker exec -it <container-id> psql -U postgres spotifyre

Client

cd client
yarn install && yarn dev

Editor Setup

VS Code

To have eslint running in VS Code, create a .vscode/settings.json file with following content:

Note: this assumes you have eslint extension installed.

{
    "eslint.workingDirectories": [
        "client/",
        "server/"
    ],
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true
    }
}

Authors

👤 Afrah Ahmed

• Github: @afrahahmed1

👤 Daniel Artuso

• Github: @dartuso

👤 Nathan Chua

• Github: @natekchua
• Website: https://natekchua.me

👤 Naweed Anwari

• Github: @naweedanwari

👤 Rakheem Dewji

• Github: @raksdewji
• Website: https://raksdewji.github.io/

Community Contributors

👤 Artem Golovin

• Github: @awave1
• Website: https://temagolovin.dev/

Technology Stack

• React used for the front-end development to build our interface on the client side.
• Material-UI used for the majority of front-end components.
• AntD used for notification component.
• React Context used for application state management.
• Node.js To handle backend requests.
• Express Framework for Node Backend.
• PostgreSQL queries to interact with the database for storage and persistence.
• Netlify used for simple CI/CD and hosting the client.
• Heroku used to host the server and PostgreSQL database.
• Spotify Web API Node universal wrapper/client for the Spotify Web API that runs on Node.JS.

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Spotifyre
This project is ISC licensed.

---

This README was generated with ❤️ by readme-md-generator