bridgets/README.md

<p align="center"> <a href="https://bridgets.co"> <img src="http://bridgets.co/assets/logo-short.svg" height="48" /> <h1 align="center">BridgeTS</h1> </a> </p>

<p align="center">
  <a href="https://bridgets.co">
    <img src="http://bridgets.co/assets/logo-short.svg" height="48" />
    <h1 align="center">BridgeTS</h1>
  </a>
</p>

<p align="center">
  <a aria-label="License" href="">
    <img alt="license" src="http://bridgets.co/assets/license.svg" height="24"/>
  </a>
  <a aria-label="Join the community on Discord" href="https://discord.gg/8TjNYgKuta">
    <img alt="community" src="http://bridgets.co/assets/community.svg" height="24" />
  </a>
</p>

## What is BridgeTS?

BridgeTs is a new Node.js framework built on Express.js that uses the power of Typescript to generate the code for the client.

In other words, its goal is that the backend developers won't have to manually write API documentation or to maintain a Postman collection to keep the client up-to-date with the API.

## Getting Started

A more detailed tutorial can be found on the <a href="https://bridgets.co"> https://bridgets.co </a> website.

We recommend creating a new **BridgeTS** app using _create-bridgeTS-app_, which sets up everything automatically for you.

To create a project, run:

```
npx create-bridgets-app
# or
yarn create-bridgets-app
```

After the installation is complete:

- Run _npm run dev_ or _yarn dev_ or to start the development server on http://localhost:8080
- Run _npm run build_ or _yarn build_ to build the static files for production
- Run _npm run start_ or _yarn start_ to start the production server on http://localhost:3000

To integrate into an existing Express.js app <a href=""> View the full documentation </a>.

## Documentation

Visit [https://bridgets.co/documentation](https://bridgets.co/documentation) to view the full documentation.

## Community

The Next.js community can be found on [Discord](https://discord.gg/8TjNYgKuta), where you can ask questions, voice ideas, and share your projects.

The framework is meant to evolve and grow, don't hesitate to share your feedback with us on and propose new features !