Skip to content

Latest commit

 

History

History
94 lines (64 loc) · 3.36 KB

README.md

File metadata and controls

94 lines (64 loc) · 3.36 KB

Polkadot Education Front-End Application

Empowering Enterprises with Blockchain Knowledge

Polkadot Education is a mobile-first responsive web app designed to provide comprehensive blockchain and Web3 education tailored for enterprises and institutions. Our goal is to guide users from the basics to advanced knowledge of Polkadot through an engaging and practical learning journey.

Website · Support

Get Started

This repository contains the front-end application for Polkadot Education. Follow the instructions below to set up and run the project locally.

1. Clone the Repository

First, clone this repository to your local machine:

git clone https://github.com/PolkadotEducation/app.git
cd app

2. Install Dependencies

Install the required dependencies using Bun:

bun install

3. Start the Development Server

To start the development server, run:

bun dev

After starting the server, open http://localhost:3000 in your browser to view the application.

Note: If you prefer a more comprehensive setup, the local-setup repository automates the process. It provides all necessary configurations and runs all required Docker containers. Simply follow the documentation in the repository, and you’ll have the backend, database, and other services up and running seamlessly.

Commands

The project has the following commands:

  • bun run build-storybook: Builds the storybook
  • bun run build: Builds the project
  • bun run db:reset: Drops database and runs the seed
  • bun run db:drop:all: Drops the database
  • bun run db:drop:courses: Drops just the courses
  • bun run db:seed:all: Runs the whole seed
  • bun run db:seed:courses: Runs the seed for courses only
  • bun run format: Runs Prettier
  • bun run format:fix: Fixes Prettier errors
  • bun run lint: Runs ESLint
  • bun run lint:fix: Fixes ESLint errors
  • bun run storybook: Runs the storybook
  • bun run test: Runs Cypress tests
  • bun run test:open: Runs Cypress tests in Launchpad mode
  • bun run type-check: Runs TypeScript check
  • bun run wait: Waits for the API to start

Project Structure

The project structure is organized as follows:

  • .github/ and .storybook/: Configuration files and workflows for continuous integration and Storybook.
  • api/: Modules related to backend API communication.
  • app/: Main application components.
  • components/: Reusable UI components.
  • context/: React context implementation for state management.
  • hooks/: Custom React hooks.
  • lib/: Helper functions and libraries.
  • public/assets/: Public files such as images and other assets.
  • stories/: Storybook files.
  • types/: TypeScript type definitions.

Contributing

We welcome contributions to the Polkadot Education project! If you have suggestions, improvements, or bug fixes, please submit a pull request or open an issue in the appropriate repository:

Contact

For any questions or support, please contact us at [email protected].

© Polkadot Education