mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-11-08 05:43:04 +00:00
docs(ai): improve onboarding steps
- Recommend `npm start` in README and CONTRIBUTING - Add forwardPorts to devcontainer.json - Add ONBOARDING_REPORT.md Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
1 parent
b48320fc9a
commit
3cd8dfd78d
4 files changed
+49
-17
No files matched your search
@@ -150,29 +150,25 @@ To run **bitvid** locally:
|
||||
npm ci
|
||||
```
|
||||
|
||||
3. Build the project:
|
||||
3. Start the application:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
npm start
|
||||
```
|
||||
|
||||
(This generates `css/tailwind.generated.css`, which is gitignored and required for styling.)
|
||||
This command builds the project (generating `css/tailwind.generated.css`) and starts a local server.
|
||||
|
||||
4. Start a local server:
|
||||
- Using Python:
|
||||
```bash
|
||||
python -m http.server 8000
|
||||
```
|
||||
- Or with Node.js:
|
||||
```bash
|
||||
npx serve
|
||||
```
|
||||
4. Open the site in your browser:
|
||||
|
||||
5. Open the site in your browser:
|
||||
```
|
||||
http://localhost:3000
|
||||
```
|
||||
|
||||
```
|
||||
http://localhost:8000
|
||||
```
|
||||
_Note: If you prefer manual steps, you can run `npm run build` followed by `npx serve` or `python -m http.server 8000`._
|
||||
|
||||
### Dev Container
|
||||
|
||||
This project includes a `.devcontainer` configuration. If you use VS Code, you can open the project in a container to get a pre-configured environment with all dependencies installed.
|
||||
|
||||
### Developer Quickstart
|
||||
|
||||
|
||||
Reference in new issue
Block a user