/boilerplate-api-core-library

Only practice how implement strucutre library for use in my other projects

Primary LanguageTypeScriptMIT LicenseMIT

@monster-codes/boilerplate-api-core-library

Welcome to the @monster-codes/boilerplate-api-core-library! This library provides a boilerplate for creating API core functionalities. We appreciate your interest in contributing to this project. This guide will help you get started with contributing to our library.

Table of Contents

  1. Getting Started
  2. Development Setup
  3. Project Structure
  4. Making Changes
  5. Testing
  6. Submitting a Pull Request
  7. Code Style
  8. Reporting Issues

Getting Started

First, fork the repository on GitHub and clone your fork locally.

git clone https://github.com/[YOUR-USERNAME]/boilerplate-api-core-library.git
cd boilerplate-api-core-library

Development Setup

  1. Install dependencies:

    yarn install

  2. Build the project:

    yarn build

  3. Run tests:

    yarn test

Project Structure

The project is structured as follows:

src/
├── client/
│   ├── DomFetchProvider.ts
│   └── index.ts
├── server/
│   ├── NodeFetchProvider.ts
│   └── index.ts
├── core/
│   ├── apiCore.ts
│   ├── settings.ts
│   └── types.ts
└── index.ts
  • client/: Contains client-side specific code
  • server/: Contains server-side specific code
  • core/: Contains shared core functionality

Making Changes

  1. Create a new branch for your feature or bugfix:

    git checkout -b feature/your-feature-name

  2. Make your changes and commit them:

    git commit -m "Description of your changes"

  3. Push your changes to your fork:

    git push origin feature/your-feature-name

Testing

We use Jest for testing. Please ensure that all new features or bug fixes are covered by tests. To run the tests:

yarn test

Submitting a Pull Request

  1. Ensure your code adheres to the existing style.
  2. Run the test suite and ensure that all tests pass.
  3. Submit a pull request with a clear title and description.

Code Style

We use TypeScript and follow these general guidelines:

  • Use 4 spaces for indentation
  • Use single quotes for strings
  • Use semicolons at the end of statements
  • Follow the existing code style in the project

Reporting Issues

If you find a bug or have a suggestion for improvement, please open an issue on the GitHub repository. When reporting issues, please include:

  • A clear and descriptive title
  • A detailed description of the issue or suggestion
  • Steps to reproduce the issue (if applicable)
  • Any relevant code snippets or error messages

Thank you for contributing to @monster-codes/boilerplate-api-core-library! 🎉 We appreciate your help in making this boilerplate better for everyone.