Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
davetaz authored Nov 11, 2024
1 parent 9345378 commit 6662eb6
Showing 1 changed file with 5 additions and 15 deletions.
20 changes: 5 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ Ensure that you have the following installed on your system:

- **Node.js** (version 14+ recommended)
- **MongoDB** (for storing validation reports)
- **Ruby** (with `csvlint` gem for performing CSV validations)

- **[csvlint-api](https://github.com/theodi/csvlint-api)** (backend service to talk with the `csvlint` validation ruby gem)

### Installation

Expand All @@ -35,10 +34,8 @@ Ensure that you have the following installed on your system:
npm install
```

3. **Install Ruby and CSVLint gem**:
```bash
gem install csvlint
```
3. **Install CSVLint API**:
Refer to documentation [here](https://github.com/theodi/csvlint-api)

4. **Set up environment variables**:
Copy `.env.example` to `.env` and set up the environment variables. Key variables include:
Expand All @@ -47,18 +44,11 @@ Ensure that you have the following installed on your system:
- `CSVLINT_API`: URL for the CSVLint Ruby server (e.g., `http://localhost:4567/validate`).
- `HOST`: Base URL for accessing the validation service (e.g., `https://csvlint.io`).

5. **Start the MongoDB server**:
```bash
mongod
```

6. **Start the Node.js server**:
5. **Start the Node.js server**:
```bash
npm start
```

7. **Start the Ruby CSVLint server**:

### Usage

#### Web Interface
Expand Down Expand Up @@ -130,4 +120,4 @@ We welcome contributions! Please follow these steps:

## License

This project is licensed under the [MIT License](LICENSE).
This project is licensed under the [MIT License](LICENSE).

0 comments on commit 6662eb6

Please sign in to comment.