Skip to content

Commit

Permalink
Merge branch 'main' of github.com:kuosc2005/website into patch-contri…
Browse files Browse the repository at this point in the history
…bution-leaderboard-api
  • Loading branch information
NotSugat committed Apr 29, 2024
2 parents 2084831 + 6729733 commit ce13e8c
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 1 deletion.
64 changes: 64 additions & 0 deletions docs/Website/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,67 @@ sidebar_position: 0
---

# About
## KUOSC Website

This site is live at [https://kuosc.org.np](https://kuosc.org.np) and is built using react and powered by [Docusaurus 2](https://docusaurus.io/) for static site generation from MDX files.
You can view the source code at [github](https://github.com/kuosc2005/website).

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

### Contributing

Contributing to this project is easy, and we welcome contributions from everyone. Here are a few guidelines to get you started:

- **Fork the repository**: Fork the repository to your GitHub account.
- **Clone the repository**: Clone the forked repository to your local machine.
- **Make your changes**: Make your changes to the codebase.
- **Test your changes**: Make sure your changes work as expected and do not introduce any regressions.
- **Commit your changes**: Commit your changes with clear and descriptive commit messages.
- **Push your changes**: Push your changes to your forked repository.
- **Submit a pull request**: Submit a pull request [here](https://github.com/kuosc2005/website/pulls) with your changes, clearly describing what you have done.

### Writing Commit Messages

Writing good commit messages is essential for maintaining a clean and readable Git history. Here are some tips for writing effective commit messages:

- **Use the imperative mood**: Start the commit message with an imperative verb, such as "Fix", "Add", "Update", etc.
- **Keep it concise**: Limit the subject line to 50 characters and use the body to provide additional context if necessary.
- **Reference related issues**: If your commit addresses a specific issue or task, reference it in the body of pull request using the issue number.

**Warning:** DONOT use `npm` or `pnpm` to install dependencies. Rather, just use `yarn`. Github actions will fail if you use anything other than yarn.
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ const config = {
items: [
{
label: 'Open School',
to: '/knowledgebase/category/open-school'
to: 'https://www.youtube.com/@kuosc'
},
{
label: 'Linux Talk',
Expand Down
3 changes: 3 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3622,6 +3622,7 @@ dot-prop@^5.2.0:
dependencies:
is-obj "^2.0.0"

<<<<<<< HEAD
dotenv-defaults@^1.0.2:
version "1.1.1"
resolved "https://registry.yarnpkg.com/dotenv-defaults/-/dotenv-defaults-1.1.1.tgz#032c024f4b5906d9990eb06d722dc74cc60ec1bd"
Expand All @@ -3641,6 +3642,8 @@ dotenv@^6.2.0:
resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-6.2.0.tgz#941c0410535d942c8becf28d3f357dbd9d476064"
integrity sha512-HygQCKUBSFl8wKQZBSemMywRWcEDNidvNbjGVyZu3nbZ8qq9ubiPoGLMdRDpfSrpkkm9BXYFkpKxxFX38o/76w==

=======
>>>>>>> 6729733911e2d6f9385fcb60b48fab76c3f92303
duplexer3@^0.1.4:
version "0.1.5"
resolved "https://registry.npmjs.org/duplexer3/-/duplexer3-0.1.5.tgz"
Expand Down

0 comments on commit ce13e8c

Please sign in to comment.