-
-
Notifications
You must be signed in to change notification settings - Fork 325
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Setup Documentation Unclear #96
Comments
I cloned the repo, installed pip3 install -r requirements.txt # worked fine
python3 migrate.py # failed
|
You should read the exceptions. It clearly says it's unable to connect to the DB
You might have missed this step mentioned in documentation.
If you just want to experiment. Use a docker image.
|
Yes, I read the exceptions. "Clearly", my point is that you should add better documentation for setting that up. There are several guides on how to write proper READMEs, along with a curated list of repos with good READMEs. |
I am not sure I understand you. What is that you expect from the readme?
What more info do you need or what you think is missing? |
The README should consider those who have little to no experience and ideally have the mentality of "Don't Make Me Think." This is especially important considering the topic of security. My suggestion would be to imagine you had a brand new computer and you were walking through the steps with a junior developer. What steps would they follow? ## Getting Started
### Pre-Reqs
* Install `python3` [using this setup guide](https://realpython.com/installing-python/)
* Note: This will install `pip3`
* Sanity check that it's working, run the following in bash: `which python3`
* Good sign is something like: `/usr/local/bin/python3`
* Install PostgresQL
* The easiest way is to Google "install postgresql <mac|windows|linux>"
* Sanity check that it's working, run the following in bash: `psql`
* Good sign: it changes to the Postgres prompt
### Installation
* In bash, run the following
* Clone the repo and `cd` into the repo: `git clone <repo name> && cd NodeJsScan`
* Install dependencies: `pip3 install -r requirements.txt`
* Create a database in Postgres: `createdb nodejsscan`
* Run the migrations to set up the database: `python3 migrate.py`
* Start the server that creates a UI: `python3 app.py`
* Navigate to `http://0.0.0.0:9090/`
### Advanced Installation
* To change the NodeJsScan database, see `core/settings.py:38`
### Basic Usage
* In the UI (`http://0.0.0.0:9090/`), compress (zip) your source files and upload
* If you don't have your own source files, use the example found at `examples/source.files.zip`
### Advanced Usage
* If you're using a transpiler or other build step, you probably have a `src` folder and a `dist` folder. You will want to upload a compressed (zipped) file of `dist`, NOT `src`
* TypeScript is not currently supported The Basic Usage section needs some work. I'm messing around with the tool now and always getting the same results, but that's another issue that I can open. |
@rgpass Instead of complaining why don't you submit a PR? |
@tforster Wasn't complaining, but I plan on submitting a PR once I get it working myself. 👍 |
That will be awesome. It's a good tool and if it takes a little effort it is worth it. I just started using it in the last week or so and created a CLI docker file so I can incorporate in my pipeline. @ajinabraham accepted my PR right away so anything we can do to help grow his project will benefit all of us. |
I am looking to experiment with NodeJsScan, but I am having trouble following the setup steps. Is it possible to add more explicit steps to getting started?
The text was updated successfully, but these errors were encountered: