Skip to content

DukeFerdinand/capychat-api

Repository files navigation

Capybara Chat - API


This the is API and GraphQL provider for the Capybara Chat application. This service is built using:

And of course, hosted on Vercel.

Getting Started

While this is not really intended to be a public project, you can still use it as a reference for your own projects. To get started, you'll need to have the following installed:

*Semi-optional, but recommended so you can test the API with the client.

Installation

  1. Clone the repo
    git clone
  2. Create a .env file in the root of the project and add the following:
    echo DATABASE_URL=<your-mongodb-uri> >> .env
  3. Install NPM packages
    yarn install
  4. Generate the Prisma client
    yarn prisma generate
  5. Run the development server
    yarn dev

Now you can make requests to the GraphQL API at http://localhost:3000/graphql or the normal API at http://localhost:3000/<whatever-route>.

Usage

This project is intended to be used with the Capybara Chat project. You're more than welcome to create your own client of course, but you'll need to make sure you're hosting this API somewhere as the production client is configured to use the non-public production API.

Copyright

I'm intentionally NOT locking this behind a closed source license. Let me know what you build, and even consider hiring me if you're a company looking for a developer. I'm a Freelancer who is always looking for new projects to work on.

Releases

No releases published

Packages

No packages published