暂无描述

attemka 1a3255c794 Environment variables description for Operator's guide (#4378) 1 年之前
.github ed39c0ab39 Upload avatar service (#2970) 2 年之前
.husky daeb150e1d update deps, fix commit hooks, fix stylelint (#1671) 3 年之前
.yarn 1346ed54f3 update dependencies, use new @joystream/types without patch 🚀 (#3458) 2 年之前
ci c4914b22a3 Update meta-server user agent rule (#4357) 1 年之前
docs 1a3255c794 Environment variables description for Operator's guide (#4378) 1 年之前
packages 1a3255c794 Environment variables description for Operator's guide (#4378) 1 年之前
.dockerignore 4bc39ca1fc monorepo setup, social previews server (#1995) 2 年之前
.eslintrc.js b485cc0e77 add eslint rule for default React import (#2888) 2 年之前
.gitignore 5504944f6b improve tree shaking by getting rid of some index.ts files (#3219) 2 年之前
.node-version 98ae11f385 upgrade to React 18, upgrade dependencies (#2860) 2 年之前
.prettierrc.js daeb150e1d update deps, fix commit hooks, fix stylelint (#1671) 3 年之前
.stylelintrc.js 440dc80dc4 update dependencies (#3522) 1 年之前
.yarnrc.yml 98ae11f385 upgrade to React 18, upgrade dependencies (#2860) 2 年之前
CHANGELOG.md fced62cfc9 operator-guide: drop duplicate YPP section (#4361) 1 年之前
CONTRIBUTING.md 679b2a6639 update documentation (#1836) 2 年之前
LICENSE b86ade3e37 update license and package.json (#438) 3 年之前
README.md 3cb45c845a add separate README section for running your own instance 2 年之前
package.json 20222eae9e Bumped node version to next LTS (#4350) 1 年之前
yarn.lock e1b3dfc5e3 Added Segment, Google Analytics, Google Optimize (#4308) 1 年之前

README.md

Discord badge Contributors badge Styleguide badge Vercel production badge Vercel development badge Storybook badge

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 image image

Running your instance

If you are interested in running your own instance of Atlas, please take a look at our operator guide. 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 - this will lay out our expectations regarding work process in GitHub, etc.
  • Code conventions and styleguide - this should help you understand code conventions we use
  • Technical overview - 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 or bug label.

Quickstart

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

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 (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.

License

All software under this project is licensed as GPLv3 unless otherwise indicated.