docs: move technical stuff to its own document

This commit is contained in:
Kim, Jimin 2023-07-04 08:10:18 +09:00
parent d2f48676a5
commit 3cc4708621
2 changed files with 49 additions and 31 deletions

48
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,48 @@
# Contribution Guide
## Things to get familiar with
- pnpm - package manager & monorepo
- React - Front-end framework
- Svelte - Front-end framework
- SvelteKit - Svelte meta-framework
## Project Structure
- `apps`
- `main` - https://developomp.com
- `blog` - https://blog.developomp.com
- `portfolio` - https://portfolio.developomp.com
- `packages` - shared stuff used across different packages
- `blog-content` - Contents for the blog
- `eslint-config` - ESLint configuration files
- `tailwind-config` -tailwindCSS configuration files
- `theme` - universal developomp theme
- `tsconfig` - TSConfig files
## Setting Up
> **If you are a Windows user:**
>
> - Do **NOT** use the Command Prompt (cmd)
> - Do **NOT** use Windows PowerShell
> - Run these commands from PowerShell or a Linux terminal such as WSL or Git Bash
>
> PowerShell and Windows PowerShell are [different applications](https://learn.microsoft.com/en-us/powershell/scripting/whats-new/differences-from-windows-powershell?view=powershell-7.3).
1. Clone this git repository
2. Install the following
- [NodeJS](https://nodejs.org)
- [pnpm](https://pnpm.io/installation)
3. Install Dependencies
```
pnpm install
```
4. Run whatever command you need either in project root or in individual packages
- `pnpm build` - Build all apps and packages
- `pnpm dev` - Run all apps and packages locally
- blog - http://localhost:3000
- main - http://localhost:5173
- portfolio - http://localhost:5174
- `pnpm lint` - Lint all apps and packages
- `pnpm clean` - Remove all auto-generated content such as `node_modules` and `dist`.

View file

@ -1,40 +1,10 @@
# developomp-site
[![what's this?](https://img.shields.io/badge/what's_this%3F-grey?style=for-the-badge)](https://portfolio.developomp.com/project/developomp-site)
[![contributing](https://img.shields.io/badge/contributing-yellow?style=for-the-badge)](./CONTRIBUTING.md)
A monorepo ([Turborepo](https://turbo.build)) of my websites for blogging, portfolio, resume, etc.
## Usage
1. Clone this git repository
2. Install [NodeJS](https://nodejs.org) and [pnpm](https://pnpm.io/installation)
3. Install Dependencies
```
pnpm install
```
4. Run whatever command you need
- `pnpm build` - Build all apps and packages
- blog: http://localhost:3000
- main: http://localhost:5173
- portfolio: http://localhost:5174
- `pnpm dev` - Run all apps and packages locally
- `pnpm lint` - Lint all apps and packages
- `pnpm clean` - Remove all auto-generated content such as `node_modules` and `dist`.
## Project Structure
- `aps`
- `main` - https://developomp.com
- `blog` - https://blog.developomp.com
- `portfolio` - https://portfolio.developomp.com
- `packages` - packages prefixed with `@developomp-site/`
- `blog-content` - Contents for the blog
- `eslint-config` - ESLint configuration files
- `tailwind-config` -tailwindCSS configuration files
- `theme` - universal developomp theme
- `tsconfig` - TSConfig files
- `utils` - Utility functions
## Special thanks
- My dear friend [Aditya Prakash](https://github.com/AdityaPrakash-26) for extensive testing and wonderful suggestions