Starter for Node.js Express API in Typescript.
Clone the repository, install the dependencies.
$ git clone [email protected]:cham11ng/typescript-api-starter.git <application-name>
$ cd <application-name>
$ cp .env.example .env # Update database credentials
$ yarn migrate
Load fake data in database.
$ yarn load:fake <FactoryName> <Number>
Start the application.
$ yarn build
$ yarn start # For production
$ yarn start:dev # For development
Using Docker
Make a copy of .env.docker
and save as .env
.
$ cp .env.docker .env
Install dependencies and run the application locally.
$ docker-compose up -d postgres
$ docker-compose up -d api
$ docker-compose exec api sh yarn migrate # Make sure server is started checking logs before running this command
View logs of the container.
$ docker-compose logs -f
To stop the services.
$ docker-compose stop api postgres
To create migration use make:migration
and seed use make:seeder
:
$ yarn make:migration create_{table_name}_table
$ yarn make:seeder {table_name}_table_seeder
Example,
$ yarn make:migration create_posts_table
$ yarn make:seeder post_table_seeder
Modify migration and seeder file as per the requirement. Then finally:
$ yarn migrate # to migrate
$ yarn seed # to seed
Feel free to send pull requests.
typescript-api-starter is under MIT License.