Skip to content

p-society/gc-web

Repository files navigation

GC-Web

Web implementation of the for the GC-Broadcasting platform. Front-end for the gc-broadcast project

P-Society Handles



Reference Design

Quick start

  • Clone the repo: git clone https://github.com/p-society/gc-web.git
  • Switch to dev branch git checkout dev
  • Make sure your Node.js and npm versions are up to date
  • Install dependencies: npm install
  • Start the server: npm run dev
  • Open browser: http://localhost:8173

Folder Structure & Config

Within the repo you'll find the following directories and config files:

├── eslint.config.mjs
├── .gitignore
├── CHANGELOG.md
├── LICENSE.md
├── package.json
├── README.md
├── tsconfig.json
├── tsconfig.node.json
├── tailwind.config.js
├── vite.config.js
├── vite-env.d.ts
├── public
└── src
    ├── assets 
	├── components
	├── layouts
	├── types
	├── services
	├── utils

Current contributors

License

  • Licensed under MIT, refer to LICENSE.md for more info

Want to Contribute?

  • Open an issue if you have a feature request or found a bug

GcBroadcastWeb

✨ Your new, shiny Nx workspace is ready ✨.

Learn more about this workspace setup and its capabilities or run npx nx graph to visually explore what was created. Now, let's get you up to speed!

Run tasks

To run the dev server for your app, use:

npx nx dev gc-broadcast-web

To create a production bundle:

npx nx build gc-broadcast-web

To see all available targets to run for a project, run:

npx nx show project gc-broadcast-web

These targets are either inferred automatically or defined in the project.json or package.json files.

More about running tasks in the docs »

Add new projects

While you could add new projects to your workspace manually, you might want to leverage Nx plugins and their code generation feature.

Use the plugin's generator to create new projects.

To generate a new application, use:

npx nx g @nx/next:app demo

To generate a new library, use:

npx nx g @nx/react:lib mylib

You can use npx nx list to get a list of installed plugins. Then, run npx nx list <plugin-name> to learn about more specific capabilities of a particular plugin. Alternatively, install Nx Console to browse plugins and generators in your IDE.

Learn more about Nx plugins » | Browse the plugin registry »

Set up CI!

Step 1

To connect to Nx Cloud, run the following command:

npx nx connect

Connecting to Nx Cloud ensures a fast and scalable CI pipeline. It includes features such as:

Step 2

Use the following command to configure a CI workflow for your workspace:

npx nx g ci-workflow

Learn more about Nx on CI

Install Nx Console

Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.

Install Nx Console »

Useful links

Learn more:

And join the Nx community:

About

Web Console for GC Broadcast

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages