Skip to content

A Template of server made with typescript, express and prisma

License

Notifications You must be signed in to change notification settings

O-Isaac/template-series-express

Repository files navigation

JavaScript Style Guide

Server Template Serie

A Template of server made with typescript, express and prisma
Getting Started »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This is my first try to make a template of a server with typescript, express and prisma.

(back to top)

Built With

(back to top)

Getting Started

This is a guide how you can install this project in local, if you want you can follow this steps!

Prerequisites

You need make account in planetscale and install all requeriments:

  • npm
  • node

Installation

  1. Fork this template with the button
  2. Make a git clone
  3. Install NPM Package
npm install
  1. Modify the schema in /prisma/schema.prisma
  2. Sync the schema with database
npm run planetscale:push
  1. Codding!

(back to top)

Usage

When you make a change in the code you need rebuild the code you can use this npm command to make a new release!

npm run build

You can format all documents with prettier

npm run prettier:fix

You can fix all with eslint

npm run litn

(back to top)

Roadmap

  • Add watcher to rebuild code!
  • Add system Auth

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/o-isaac/template-series-express

(back to top)

Acknowledgments

(back to top)

About

A Template of server made with typescript, express and prisma

Resources

License

Stars

Watchers

Forks