Docs: Create an issue template to add users as contributors

This repo is archived. If you are looking for the latest, check out open-sauced/insights or open-sauced/hot.

🍕 Open Sauced 🍕

The path to your next Open Source contribution

Open Sauced provides structured onboarding for new contributors to open source. This structure provides a way to track your next contributions by leveraging a unique dashboard built on top of the GitHub GraphQL API.

📖 Prerequisites

In order to run the project from a container we need node>=14, npm>=7 and docker>=20 installed on our development machines or use one of the listed cloud providers we support:

Gitpod

✅ fully ready integrated development environment

⭕ VS Code settings sync is not ideal

Gitpod is mostly free but has extensive documentation for all its contributing features.

For Vite to work with Gitpod we need to use a custom Dockerfile that lives under .gitpod.Dockerfile.

Open Sauced comes with a pre-defined .gitpod.yml that should work out of the box in multiple contribution scenarios.

Replit

✅ fully ready integrated development environment

⭕ modified contribution workflows

Replit is an old service that recently supported NixOS, enabling full customisation of the runner and project.

Open Sauced is configured with a shell environment supporting node@16 and npm@8. The build environment script lives in shell.nix and the repl config lives in .replit.

Codesandbox

✅ can be used as editor replacement

✅ supports deployment preview

⭕ enforces custom package manager for stability

⭕ low resources free tier limitations

Stackblitz

✅ can be used as editor replacement

✅ supports deployment preview

⭕ enforces custom package manager for stability

⭕ limited documentation on container limitations

Glitch

✅ can be used as editor replacement

✅ supports deployment preview

⭕ enforces custom package manager for stability

⭕ does not support stacked hot module reload

⭕ severely low resources free tier limitations

🖥️ Local development

To install the application:

npm ci

To start a local copy of the app on port 3000:

npm start

🧪 Test

For running the test suite, use the following command. Since the tests run in watch mode by default, some users may encounter errors about too many files being open. In this case, it may be beneficial to install watchman.

npm test

You can request a coverage report by running the following command:

npm run test:coverage

📦 Docker builds

A development preview can also be run from docker:

docker build -t open-sauced-dev .
docker run -p 8080:80 open-sauced-dev

Alternatively you can pull the production container and skip all builds:

docker run -dit -p 8080:80 ghcr.io/open-sauced/open-sauced

🎨 Code linting

To check the code and styles quality, use the following command:

npm run lint

This will also display during development, but not break on errors.

To fix the linting errors, use the following command:

npm run format

🚀 Production deployment

A production deployment is a complete build of the project, including the build of the static assets.

npm run build

You can analyze the build by running the following command:

npm run build:analyze

🎭 Offline asset optimization

We also have a script for updating .svg files used in the project, you only need to run this if you add new assets:

npm run build:svgo

And one for .png and .jpg files:

npm run build:squoosh

🚧 Development debugging

Thanks to antfu/vite-plugin-inspect we can always inspect the bundles in development by navigating to localhost:3000/__inspect/ in your browser.

📙 Storybook

Storybook is being leveraged to mock out visual React components. The latest version of the design system can be found at this URL.

npm run storybook

🔑 Authentication

Authentication is handled through OneGraph's AuthGuardian service.

💾 Database

This project uses GitHub as a database. When you login, you will be presented with a button to create a goals repository. That repository template lives at open-sauced/goals-template.

💨 Service Worker

This project uses the sw-precache to kickstart an offline cache. The offline cache only registers in production. If service needs to be manually removed make an unregister call from the registerServiceWorker.js import.

🌙 Dark Mode

This project supports "dark mode" styling, and by default it will follow the color preference on your device. It also allows for overriding this using buttons at the top right of the screen, which will persist the preference to local storage on your device. More info about color preference web API's can be found here: MDN Web Docs

📝 Markdown Support

This project leverages Remirror for a delightful experience in documenting your Open Source goals. The editor supports markdown features including heading levels, bulleted lists, text formatting, code snippets, and emojis!

🤝 Contributing

We encourage you to contribute to Open Sauced! Please check out the Contributing guide for guidelines about how to proceed.

We have a commit utility called @open-sauced/conventional-commit that helps you write your commits in a way that is easy to understand and process by others.

It is generally integrated as an npm script but you can run it with npx as well:

npm run push

For any other npm based project or dotnpmrc defaulting to --yes:

npx -y @open-sauced/conventional-commit

🍕 Community

Got Questions? Join the conversation in our Discord.
Find Open Sauced videos and release overviews on our YouTube Channel.

	### How did you add yourself as a contributor?

	- [ ] 🤖 With CLI
	- [ ] ⌨️ Manually

	#### If you added yourself manually, did you follow the [emoji key and contribution types](https://allcontributors.org/docs/en/emoji-key) to fill in the value?

	- [ ] ✅ Yes
	- [ ] ❌ No

	### Running the Project Locally

	To contribute effectively to the OpenSauced project, it's essential to run the project locally to see your changes in action and test them thoroughly. We recommend two methods for running the project on your local machine: using the Docsify CLI or leveraging Visual Studio Code's Go Live feature.

	#### Method 1: Using the Docsify CLI

	1. Install Node.js: You can download it from the official Node.js [website](https://nodejs.org/.)
	2. Install Docsify Globally: Open your command-line interface (CLI) and run the following command to install Docsify globally.

	```bash
	npm install -g docsify-cli
	```

	3. Run the project locally:

	```bash
	docsify serve
	```

	This command will start a local development server, and you can access the documentation in your web browser at `http://localhost:3000`

	4. Make and Test Changes: With the local server running, you can make changes to the documentation files and immediately see the results in your browser. Test your changes thoroughly.
	5. Stop the Server: When you're done testing or making changes, you can stop the local server by pressing `Ctrl + C` in the CLI.

	#### Method 2: Using Visual Studio Code (VS Code) Go Live Feature

	Once you have cloned the repository to your local machine, you can use VS Code's Go Live feature to run the project locally. This feature allows you to launch a local development server and preview your changes in real time in your browser.

	1. Install Visual Studio Code: Download and install [Visual Studio Code](https://code.visualstudio.com/).
	2. Open the Project in VS Code: Launch VS Code and open the project folder by selecting "File" > "Open Folder" and choosing the project directory.
	3. Install the Live Server Extension: In VS Code, navigate to the Extensions view (you can press `Ctrl + Shift + X`) and search for "Live Server. Install the "Live Server" extension by Ritwick Dey.

	4. Launch the Live Server: In the opened HTML file, you should see a "Go Live" button in the bottom-right corner of the VS Code window. Click this button to launch the live server.

	This will open your documentation in a new browser tab at a local address (typically `http://127.0.0.1:5500`).

	6. Make and Test Changes: With the Live Server running, you can make changes to the documentation files using VS Code, and the changes will be automatically reflected in your browser. Test your changes thoroughly.

	7. Stop the Live Server: When you're done testing or making changes, you can stop the Live Server by clicking the "Exit" button in the VS Code status bar.

	## Adding a New Section to the Documentation

	Welcome to the documentation contribution guide. In this guide, you will learn how to add a new section to our project's documentation. We have specific conventions for numbering sections to maintain a consistent structure.

open-sauced / guestbook Goto Github PK

guestbook's Introduction

🍕 Open Sauced 🍕

📖 Prerequisites

Gitpod

Replit

Codesandbox

Stackblitz

Glitch

🖥️ Local development

🧪 Test

📦 Docker builds

🎨 Code linting

🚀 Production deployment

🎭 Offline asset optimization

🚧 Development debugging

📙 Storybook

🔑 Authentication

💾 Database

💨 Service Worker

🌙 Dark Mode

📝 Markdown Support

🤝 Contributing

🍕 Community

🎦 Repository Visualization

⚖️ LICENSE

guestbook's People

Contributors

Stargazers

Watchers

Forkers

guestbook's Issues

Description

Suggested Solution

Description

Suggestion

Describe the bug

Steps to reproduce

Browsers

Additional context (Is this in dev or production?)

Code of Conduct

Contributing Docs

Type of feature

Current behavior

Suggested solution

Additional context

Code of Conduct

Contributing Docs

Type of feature

Current behavior

Suggested solution

Additional context

Code of Conduct

Contributing Docs

Description

Suggested solution

Code of Conduct

Getting Started Instructions

Describe the bug

Steps to reproduce

Browsers

Additional context (Is this in dev or production?)

Code of Conduct

Contributing Docs

Type of feature

Current behavior

Suggested solution

Additional context

Code of Conduct

Contributing Docs

Description

Suggested Solution

Describe the bug

Steps to reproduce

Browsers

Additional context (Is this in dev or production?)

Code of Conduct

Contributing Docs

Type of feature

Current behavior