https://github.com/samirprakash/typegraphql-server-boilerplate
A backend server using TypeGraphql, TypeORM, TypeScript and Postgres for an e-commerce website and app
https://github.com/samirprakash/typegraphql-server-boilerplate
graphql nodejs postgres redis typegraphql
Last synced: 4 months ago
JSON representation
A backend server using TypeGraphql, TypeORM, TypeScript and Postgres for an e-commerce website and app
- Host: GitHub
- URL: https://github.com/samirprakash/typegraphql-server-boilerplate
- Owner: samirprakash
- License: mit
- Created: 2019-01-26T20:15:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-12T01:02:18.000Z (almost 4 years ago)
- Last Synced: 2023-03-08T12:39:04.896Z (about 2 years ago)
- Topics: graphql, nodejs, postgres, redis, typegraphql
- Language: TypeScript
- Size: 979 KB
- Stars: 5
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TypeGraphQL server boilerplate
A graphQL and typegraphql based server boilerplate to be used as a backend for an e-commerce based web application or mobile app.
## Getting Started
- Get the pre-requisites done
- Open a new terminal window and CD to your workspace
- Clone this repo
### Prerequisites
- Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- Install [Node JS](https://nodejs.org/en/)
- Install [yarn](https://yarnpkg.com/en/)
- Install [Postgress app](https://postgresapp.com/)
- Install [redis](https://redis.io/download)
Make sure that postgres is up and running. Look at [ormconfig](./ormconfig.json) and based on the values specified under default connection, create a user, password and database in postgres. if you want, you create your own username and password in postgres and update `ormconfig.json`.
After installing redis, execute `redis-server` in a standalone terminal to have redis running.
### Installing
- Open a new terminal and CD to your cloned repo
- Execute `yarn install` on the terminal
- Execute `yarn start` to get the build dependencies
- Check that there are no errors on the terminal
- Server will start at `http://localhost:4000/graphql`
> http://localhost:4000/graphql is the Graphql playground where we can test the server side implementation.
> Look [here](./docs/graphql-samples/) to checkout the examples for verifying our flows for login, registration, etc.
## Running the tests
Execute `yarn test` to execute the tests that are present in this application code base. Ensure that tests are present before executing the command or else an error would be generated.
## Deployment
`TBD`
## Contributing
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Authors
- [@samirprakash](https://github.com/samirprakash)