Skip to content

permaweb/AOS-Web

Repository files navigation

AOS Web React Project

aosWebApp PLZ FORK THIS AND MAKE IT YOUR OWN. =]

Overview

Our intention with AOS Web was to create something fun to use and inspire others in terms of UX/UI of what's possible on the permaweb. Some handy features that are our personal favorites include:

  • Saving your AO processes to keep track of everything you've got going on
  • Auto-completing commonly used commands
  • Keeping track of what quests are available to complete

Our goal was to create a tool that's both enjoyable to use and a source of inspiration for others exploring the potential of the permaweb.

Project Structure

Here are some important directories to pay attention to in this project:

/src
├── components
│   ├── data_component
│   │   └── ProcessList.tsx
│   ├── layouts
│   │   └── MainLayout.tsx
│   ├── terminals
│   │   └── Terminals
│   ├── modals
│   │   └── [Modals Components]
│   └── views
│       └── Dashboard
│           └── index.tsx

Components

Data Components

  • Path: /src/components/data_component
  • Description: This directory contains components that handle data. Notably, it includes ProcessList.tsx, which is responsible for displaying the list of processes.

Layout Components

  • Path: /src/components/layouts/MainLayout.tsx
  • Description: This file contains the overall layout of the application.

Terminal Components

  • Path: /src/components/Terminals
  • Description: This directory contains components related to terminal functionality.

Modals

  • Path: /src/components/modals
  • Description: This directory contains modal components, such as those used for creating new processes.

Views

  • Path: /src/components/views/Dashboard/index.tsx
  • Description: The main page of the application, which provides the primary user interface, is located in this file.

React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

  • Configure the top-level parserOptions property like this:
export default {
  // other rules...
  parserOptions: {
    ecmaVersion: 'latest',
    sourceType: 'module',
    project: ['./tsconfig.json', './tsconfig.node.json'],
    tsconfigRootDir: __dirname,
  },
}
  • Replace plugin:@typescript-eslint/recommended to plugin:@typescript-eslint/recommended-type-checked or plugin:@typescript-eslint/strict-type-checked
  • Optionally add plugin:@typescript-eslint/stylistic-type-checked
  • Install eslint-plugin-react and add plugin:react/recommended & plugin:react/jsx-runtime to the extends list

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published