species-finder-db

Description

species-finder-db is a Node.js project that interacts with a PostgreSQL database using Knex.js for migrations and queries. It is designed to help find and manage market species data.

Version

1.0.0

License

MIT

Author

Felix Manuel [email protected]

Repository

Git Repository

Installation

To get started with species-finder-db, you'll need to install the necessary dependencies. Run the following command:

yarn install

## Scripts

The following scripts are available for managing the project:

- **Build**: Compile TypeScript code to JavaScript.

  ```bash
  yarn build
  ```

- **Start**: Run the compiled JavaScript code.

  ```bash
  yarn start
  ```

- **Build and Start**: Run both build and start scripts sequentially.

  ```bash
  yarn build-start
  ```

- **Knex Migrate Up**: Apply all pending migrations.

  ```bash
  yarn knex:up
  ```

- **Knex Latest Migrations**: Run all migrations up to the latest.

  ```bash
  yarn knex:latest
  ```

- **Knex Migrate Down**: Roll back the last batch of migrations.

  ```bash
  yarn knex:down
  ```

- **Knex Make Migration**: Create a new migration file.
  ```bash
  yarn knex:make
  ```

## Development Dependencies

The following development dependencies are used in this project:

- `@eslint/js`: ESLint configuration for JavaScript.
- `@types/node`: TypeScript definitions for Node.js.
- `@typescript-eslint/eslint-plugin`: ESLint plugin for TypeScript.
- `@typescript-eslint/parser`: ESLint parser for TypeScript.
- `eslint`: Linter for identifying and reporting on patterns in JavaScript.
- `globals`: Defines global variables for various environments.
- `ts-node`: TypeScript execution environment for Node.js.
- `typescript`: TypeScript language support.
- `typescript-eslint`: TypeScript linting rules.

## Dependencies

The following dependencies are required to run the project:

- `dotenv`: Loads environment variables from a `.env` file.
- `knex`: SQL query builder and migration tool.
- `pg`: PostgreSQL client for Node.js.

## Contributing

If you would like to contribute to the project, please follow the standard pull request process and ensure that your code adheres to the project's coding standards.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

```

Feel free to customize the README further based on any additional information or preferences you may have!
```