A GraphQL API for retrieving information about businesses registered in Canada.
AGPL-3.0 License
A GraphQL API for retrieving information about businesses registered in Canada. The API is built using GraphQL, a modern and flexible query language for APIs.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them:
Install as dependency:
yarn add @dipakparmar/ca-business-registry-graphql
Setup a server using the following code:
import { createCABusinessRegistryGraphQLServer } from '@dipakparmar/ca-business-registry-graphql'
const server = createCABusinessRegistryGraphQLServer({
landingPage: true,
graphqlEndpoint: '/alpha/graphql',
graphiql: true,
})
server.listen(4000, () => {
console.log('🚀 Server ready at http://localhost:4000')
})
Start the dev server:
yarn dev
The server should now be running on http://localhost:4000 or port specified in .env file. You can now open the GraphQL Playground at http://localhost:4000/alpha/graphql to start querying the API.
The API supports the following query fields:
git checkout -b feature/my-new-feature
)git commit -ams -S 'Add some feature'
)git push origin feature/my-new-feature
)This project is licensed with the AGPL-3.0 License.