Skip to content

Commit

Permalink
chore(root): add projects description
Browse files Browse the repository at this point in the history
  • Loading branch information
neuodev committed Aug 5, 2024
1 parent 1cf3bf5 commit 934be31
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 110 deletions.
2 changes: 1 addition & 1 deletion atlas/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Atlas (moon of Saturn)
# Atlas (Moon of Saturn)

LiteSpace API SDK
2 changes: 1 addition & 1 deletion atlas/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@litespace/atlas",
"version": "1.0.0",
"description": "LiteSpace API SDK",
"version": "1.0.0",
"main": "dist/cjs/index.js",
"module": "dist/esm/index.js",
"files": [
Expand Down
31 changes: 2 additions & 29 deletions luna/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,3 @@
# React + TypeScript + Vite
# Luna

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

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## 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:

```js
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](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
LiteSpace components, storybook, and design system.
1 change: 1 addition & 0 deletions luna/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@litespace/luna",
"description": "LiteSpace Components & Design System",
"private": true,
"version": "1.0.0",
"type": "module",
Expand Down
2 changes: 1 addition & 1 deletion nebula/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Nebula
# Nebula (any diffused astronomical object)

LiteSpace landing page
1 change: 1 addition & 0 deletions nebula/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@litespace/nebula",
"description": "LiteSpace landing page",
"version": "0.1.0",
"private": true,
"scripts": {
Expand Down
31 changes: 2 additions & 29 deletions nova/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,3 @@
# React + TypeScript + Vite
# Nova (new starts)

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

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## 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:

```js
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](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
LiteSpace main web platform
51 changes: 2 additions & 49 deletions orbit/README.MD
Original file line number Diff line number Diff line change
@@ -1,50 +1,3 @@
# orbit
# Orbit

<div align="center" style="margin: 30px;">
<a href="https://refine.dev">
<img alt="refine logo" src="https://refine.ams3.cdn.digitaloceanspaces.com/readme/refine-readme-banner.png">
</a>
</div>
<br/>

This [Refine](https://github.com/refinedev/refine) project was generated with [create refine-app](https://github.com/refinedev/refine/tree/master/packages/create-refine-app).

## Getting Started

A React Framework for building internal tools, admin panels, dashboards & B2B apps with unmatched flexibility ✨

Refine's hooks and components simplifies the development process and eliminates the repetitive tasks by providing industry-standard solutions for crucial aspects of a project, including authentication, access control, routing, networking, state management, and i18n.

## Available Scripts

### Running the development server.

```bash
yarn dev
```

### Building for production.

```bash
yarn build
```

### Running the production server.

```bash
yarn start
```

## Learn More

To learn more about **Refine**, please check out the [Documentation](https://refine.dev/docs)

- **REST Data Provider** [Docs](https://refine.dev/docs/core/providers/data-provider/#overview)
- **Ant Design** [Docs](https://refine.dev/docs/ui-frameworks/antd/tutorial/)
- **React Router** [Docs](https://refine.dev/docs/core/providers/router-provider/)
- **Custom Auth Provider** [Docs](https://refine.dev/docs/core/providers/auth-provider/)


## License

MIT
LiteSpace Admin dashboard
1 change: 1 addition & 0 deletions orbit/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "@litespace/orbit",
"description": "LiteSpace dashboard",
"version": "0.1.0",
"private": true,
"type": "module",
Expand Down

0 comments on commit 934be31

Please sign in to comment.