Using Codespaces and Gitpod
CBID2 opened this issue · comments
Type of feature
🍕 Feature
Current behavior
After helping @RitaDee with her contribution, I noticed that setting up the development environment was a bit difficult (e.g., viewing the docs site locally did not work). Since Hacktoberfest is starting Sunday, it's crucial for contributors, especially those who are new to open source, to have a somewhat easy way to get started.
Suggested solution
Adding links to GitHub Codespaces and Gitpod would be very helpful. It'll make it easier for contributors to step up their coding environment in a quicker fashion and to start contributing.
Additional context
No response
Code of Conduct
- I agree to follow this project's Code of Conduct
Contributing Docs
- I agree to follow this project's Contribution Docs
@CBID2 what methods were attempted to get it running? And what errors were you running into?
@CBID2 can you create a bug report or include the error message here? I think we should tackle the error before adding anything else.
Did you use the README directions for how to run the project? npm ci, npm start?
@CBID2 what methods were attempted to get it running? And what errors were you running into?
I ran npm ci and npm start initially but got the error below:
npm ERR!
npm ERR! Did you mean one of these?
npm ERR! npm star # Mark your favorite packages
npm ERR! npm stars # View packages marked as favorites
npm ERR!
npm ERR! To see a list of scripts, run:
npm ERR! npm run```
@CBID2 what methods were attempted to get it running? And what errors were you running into?
@BekahHW, the
docsify servecommand didn't work and the dependencies were missing, so I suggested Rita to use Gitpod and things were fine from there.
The "docsify serve" command didn’t work on my device. Here is the screenshot:
@RitaDee and @CBID2, the main docs repository uses Docusaurus and not docsify.
If you run
npm ci npm starteverything will load up.
The error I encountered was on the intro repo (https://github.com/open-sauced/intro). I observed it has no package.json file. I suspect that could be the issue. What do you think @nickytonline?
Sorry for the confusion as this issue is in the docs repository. The issue appears to be that docsify isn't installed globally on your machine. I'm going to transfer this issue over to that repository instead.
@BekahHW, it looks like the README doesn't mention installing docsify globally, i.e. npm install docsify -g. That's one way to run it or you can create a package.json and add docsify as a dependency and have a command like npm start that runs docsify.
Ok, I need to clarify here. Where is the issue? In the Intro course or the docs?
For the intro course, we have a contributing guide PR that will have directions for docsify or how to use Go Live in VS code.
If the issue is in the docs repo, then docsify won't work there, as Nick mentioned it uses docusaurus so you have to run npm ci and npm start.
Thanks for chiming in @BekahHW. If there's a PR up for how to use docsify, awesome.
Thanks for clarifying @nickytonline. I mentioned this as a reason to implement links to Codespaces and Gitpod. Is that still a possible suggestion?