simplified docs and prevent workflow from running incorrectly in other people's repo
This commit is contained in:
parent
87322e08c3
commit
b6c3fe5517
4 changed files with 28 additions and 69 deletions
|
@ -6,6 +6,7 @@ on:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
|
if: ${{ github.repository_owner == 'developomp' }}
|
||||||
name: Build
|
name: Build
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
@ -26,6 +27,7 @@ jobs:
|
||||||
path: source/build
|
path: source/build
|
||||||
|
|
||||||
deploy:
|
deploy:
|
||||||
|
if: ${{ github.repository_owner == 'developomp' }}
|
||||||
name: Deploy
|
name: Deploy
|
||||||
needs: build
|
needs: build
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
|
@ -1,28 +0,0 @@
|
||||||
# Contributing
|
|
||||||
|
|
||||||
## Before starting
|
|
||||||
|
|
||||||
tl;dr for dummies:
|
|
||||||
|
|
||||||
- Suggestions and Bug reports here: [GitHub issues page](https://github.com/developomp/developomp-site/issues)
|
|
||||||
- contribution is only for developers
|
|
||||||
- code contributions only. No article contribution.
|
|
||||||
|
|
||||||
This document is aimed for developers. Basic level of development knowledge is expected from the contributors.
|
|
||||||
To be specific, contributors are expected to be familiar with the javascript language, react framework, code analyzers, and formatters.
|
|
||||||
If you are **not** a developer, but have suggestions and/or bugs you wish to report, feel free to do so in the [GitHub issues page](https://github.com/developomp/developomp-site/issues).
|
|
||||||
|
|
||||||
## Guidelines
|
|
||||||
|
|
||||||
- Usage of vscode is highly recommended. Other IDE are allowed as long as the code style is consistent.
|
|
||||||
- All contributions must be made in form of a github pull request. Sending code through email or other platform is not welcomed.
|
|
||||||
- Format code using the [prettier](https://prettier.io) formatter with [this](./.prettierrc) configuration.
|
|
||||||
- Test your code before making a pull request.
|
|
||||||
- Make sure to write basic comments to help other people understand your code at first glance.
|
|
||||||
- Add a comment in the following format for each code file.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
/** filename.tsx
|
|
||||||
* what it does and why it exists
|
|
||||||
*/
|
|
||||||
```
|
|
67
README.md
67
README.md
|
@ -1,69 +1,54 @@
|
||||||
# developomp-site
|
# developomp-site
|
||||||
|
|
||||||
[](./LICENSE)
|
[](./LICENSE)
|
||||||
[](https://github.com/prettier/prettier)
|
|
||||||
|
|
||||||
Source code for my (developomp's) <a href="https://developomp.com" target="_blank">website</a>.
|
Source code for my (developomp's) <a href="https://developomp.com" target="_blank">website</a>.
|
||||||
|
|
||||||
# Setup
|
## Setup
|
||||||
|
|
||||||
Requirements:
|
### Requirements
|
||||||
|
|
||||||
- [node](https://nodejs.org)
|
- [nodeJS](https://nodejs.org)
|
||||||
- [yarn](https://github.com/yarnpkg/yarn)
|
- [yarn](https://github.com/yarnpkg/yarn)
|
||||||
- optional:
|
|
||||||
- [vscode](https://code.visualstudio.com)
|
|
||||||
- [extensions](./.vscode/extensions.json) (also optional but highly recommended)
|
|
||||||
|
|
||||||
Steps:
|
### Steps
|
||||||
|
|
||||||
- Clone this repository
|
#### 1. Clone this repository
|
||||||
|
|
||||||
`git clone https://github.com/developomp/developomp-site.git`
|
```bash
|
||||||
|
git clone https://github.com/developomp/developomp-site.git
|
||||||
|
```
|
||||||
|
|
||||||
- Or download as a zip file
|
#### 2. Open the [`source`](./source) directory
|
||||||
|
|
||||||

|
```bash
|
||||||
|
cd source
|
||||||
|
```
|
||||||
|
|
||||||
- open [`source`](./source) directory
|
#### 3. Install dependencies
|
||||||
|
|
||||||
`cd source`
|
```bash
|
||||||
|
yarn install
|
||||||
|
```
|
||||||
|
|
||||||
- Install dependencies (must be in `source` directory)
|
#### 4. Test locally
|
||||||
|
|
||||||
`yarn install`
|
```bash
|
||||||
|
yarn start
|
||||||
|
```
|
||||||
|
|
||||||
- start local server in http://localhost:3000
|
## Special thanks
|
||||||
|
|
||||||
`yarn start`
|
|
||||||
|
|
||||||
# Contributing
|
|
||||||
|
|
||||||
Please read the [`CONTRIBUTING.md`](./CONTRIBUTING.md) file.
|
|
||||||
|
|
||||||
# How it works
|
|
||||||
|
|
||||||
> Check the comments [`generator.ts`](./source/generate.ts) file for more detailed information.
|
|
||||||
|
|
||||||
When you run the `yarn start` command, the project executes the [generate.ts](./source/generate.ts) script before starting the app. This script converts [markdown files](./source/markdown) to json files so it can be imported by react on the frontend.
|
|
||||||
|
|
||||||
To perform the conversion without starting the app, run `yarn generate` command.
|
|
||||||
|
|
||||||
To start the app without generating json files, run `yarn quick-start` command.
|
|
||||||
|
|
||||||
# Special thanks
|
|
||||||
|
|
||||||
|
- My dear friend [Aditya Prakash](https://github.com/AdityaPrakash-26) for extensive testing and wonderful suggestions
|
||||||
- [Ruipeng Zhang](https://github.com/ppoffice) for design inspiration ([hexo-icarus-theme](https://github.com/ppoffice/hexo-theme-icarus))
|
- [Ruipeng Zhang](https://github.com/ppoffice) for design inspiration ([hexo-icarus-theme](https://github.com/ppoffice/hexo-theme-icarus))
|
||||||
- [Artem Golubin](https://github.com/rushter) for design inspiration ([his blog](https://rushter.com/blog))
|
- [Artem Golubin](https://github.com/rushter) for design inspiration ([his blog](https://rushter.com/blog))
|
||||||
- [discord](http://discord.com) for dark theme color palette (before the [rebranding of May 2021](https://blog.discord.com/how-were-making-discord-more-welcoming-for-everyone-ee152f198c60))
|
- [discord](http://discord.com) for dark theme color palette (before the [rebranding of May 2021](https://blog.discord.com/how-were-making-discord-more-welcoming-for-everyone-ee152f198c60))
|
||||||
- My dear friend [Aditya Prakash](https://github.com/AdityaPrakash-26) for extensive testing and wonderful suggestions
|
|
||||||
|
|
||||||
# License
|
## License
|
||||||
|
|
||||||
This project is licensed under the MIT License.<br>
|
The source code for this project is available under the [MIT License](./LICENSE).<br>
|
||||||
Check the [LICENSE](./LICENSE) file for more information.
|
|
||||||
|
|
||||||
Font license:
|
Font licenses:
|
||||||
|
|
||||||
[Open Font License (OFL)](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL#5667e9e4):
|
[Open Font License (OFL)](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL#5667e9e4):
|
||||||
|
|
||||||
|
|
BIN
downloading.png
BIN
downloading.png
Binary file not shown.
Before Width: | Height: | Size: 39 KiB |
Loading…
Add table
Add a link
Reference in a new issue