TelescopeThieves / motifs-deploy

Motifs

A platform for ephemeral audio. Posts made on Motifs disappear in 24 hours!
Explore the docs »

View Live · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. Contact

About The Project

Motifs is a web application where musicians can post ephemeral music. Posts on Motifs are automatically deleted within 24 hours of creation. Users are allowed to bookmark posts while they’re still live and follow their favorite creators. Options for permanent uploads and in app music purchasing are in the works.

Like counts and play counts are kept hidden to create an environment that is more focused on the music than the metrics. We believe musicians shouldn't judge the worth of their art via numbers and graphs!

Built With

• React
• NodeJs
• Express
• MongoDB
• Cloudinary
• Phosphor Icons

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Install NodeJS
• Install npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/TelescopeThieves/motifs-deploy.git

2. Install Server-Side NPM packages:

• From the project's root folder on the terminal run

  npm install

3. Install Client-Side NPM packages:

• From the project's client folder on the terminal run

  npm install

4. Create a Cloudinary account. In your Account Details you will find your Cloudinary cloud name, API Key and API secret.
5. Create a mongoDb account and create a new cluster. Here's a youTube video if you need help.
6. Navigate to the config folder and create a .env file with the following variables:

PORT = 5000
CLOUD_NAME = Your cloudinary cloud name
API_KEY = Your cloudinary API key
API_SECRET = Your cloudinary API secret
DB_STRING = Your mongoDb cluster connection string
ACCESS_TOKEN_SECRET = A password of your choice
REFRESH_TOKEN_SECRET = A password of your choice
NODE_ENV=development

7. CD into the root folder from the terminal and run

   npm run dev

8. CD into the client folder from the terminal and run

   npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Twitter - @TelescpeThieves Email - [e-mail]

Project Link: https://github.com/TelescopeThieves/motifs-deploy