https://github.com/joystream/atlas

Whitelabel consumer and publisher experience for Joystream
https://github.com/joystream/atlas

blockchain cryptocurrency dao joystream typescript web3

Last synced: about 2 months ago
JSON representation

Whitelabel consumer and publisher experience for Joystream

• Host: GitHub
• URL: https://github.com/joystream/atlas
• Owner: Joystream
• License: gpl-3.0
• Created: 2020-11-24T12:55:19.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T11:20:05.000Z (9 months ago)
• Last Synced: 2024-05-16T12:35:42.767Z (9 months ago)
• Topics: blockchain, cryptocurrency, dao, joystream, typescript, web3
• Language: TypeScript
• Homepage: https://www.joystream.org
• Size: 36.3 MB
• Stars: 101
• Watchers: 6
• Forks: 44
• Open Issues: 423
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    





  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



#### Functionality

- Watch content hosted on the Joystream network

- Explore most popular content and channels

- Sign up for your Joystream membership

- Create a channel and publish content

- Issue and trade NFTs for the content you've published

#### Screenshots

![image](https://user-images.githubusercontent.com/35307309/147930525-8bb61647-d908-47d1-96c0-494080a2aad6.png)

![image](https://user-images.githubusercontent.com/35307309/147930535-9082f52b-6b34-45e1-b627-4d8372b0163b.png)

![image](https://user-images.githubusercontent.com/35307309/147930541-c2f75fe5-ddba-48de-9536-eac228961757.png)

## Running your instance

If you are interested in running your own instance of Atlas, please take a look at our [operator guide](docs/operator-guide.md). It should give you a proper overview of all the setup you will have to do.

## Contributing

All community contributions to the project are welcome. Before starting any work, it's a good idea to get familiar with the following additional documents:

- [CONTRIBUTING.md](CONTRIBUTING.md) - this will lay out our expectations regarding work process in GitHub, etc.

- [Code conventions and styleguide](docs/styleguide.md) - this should help you understand code conventions we use

- [Technical overview](docs/overview.md) - this document describes Atlas' technical architecture, what data sources it fetches from, what tech is used to build it, etc.

If you are looking for a good place to start, check out the [good first issue label](https://github.com/Joystream/atlas/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [bug label](https://github.com/Joystream/atlas/issues?q=is%3Aissue+is%3Aopen+label%3Abug).

### Quickstart

To get started working with Atlas codebase, first clone the repo, install all dependencies and run the development server.

```bash

git clone https://github.com/Joystream/atlas

cd atlas

yarn install

yarn atlas:dev

```

This will start the development server on `localhost:3000`.

### Design

To get started working with Atlas designs in Figma, visit [Joystream's official Figma Community profile](https://figma.com/@joystream) (available early 2022) and duplicate files you're interested in remixing or using as a base for your work.

While most of the Atlas design documentation is kept within Figma files, for meta documentation visit [Atlas Design Space on Notion](https://joystream.notion.site/Design-Space-487ed84966fa495a8c037935639ca681).

## License

All software under this project is licensed as [GPLv3](LICENSE) unless otherwise indicated.