Giter VIP home page Giter VIP logo

node-express-js-template's Introduction

Welcome to my node-express.js template ๐Ÿ˜Œ

if you are looking for a quick and ready to use typescript nodejs with express template,

look no further ๐Ÿ˜Œ

made with โค๏ธ by RashJrEdmund

get your own copy here


Description / Content

This template repo has been setup with TypeScript, SASS, EJS MongoDb, and Mongoose. Also, a simple user endpoint has been created with /users, and the actuall schema created mongoose and MongoDb initiallized, but will need your mongo_connections url.

Quick start

  • run

      npx degit "RashJrEdmund/node-express-js-template" my-express-app

    To setup the repo locally. you can replace my-express-app with your actuall app name

Afterwards

  • run npm install to install all neccesarry dependencies.

  • open package.json or run npm run to see all available scripts.

  • run npm run dev to start both sass:compiler and nodemone.


Files/Folders to Delete

  • readme-assets (Folder)

    • run rm -rf ./readme-assets at the root of your project. it contains readme assest.
  • README.md (File)

    • run rm -rf ./README.md at the root of your project. it contains readme it self.

Files to edit

  • server.ts

    • open src/server.ts. it is the main entry point to the application.
  • express.app.ts

    • open src/services/express/express.app.ts It here that the main middle-wares like CORS and express.json(). Even ejs has been setup as the templating enjine and the views directory set to views...
  • express.entrypoints.ts

    • open src/services/epress/express.entrypoints.ts. It is here you'll setup your routes.
  • config.ts

    • open src/config/config.ts. dotenv has been configure here, and the required configurations for ur app are here. like the db configs, app, jwt, bcrypt are all here. add anymore u see fit.
  • constants.ts

    • open src/services/constants.ts. dotenv has also been configure here, you could add and load some of env or add constant data/state here.
  • interfaces/entities.ts

    • open src/utils/interfaces/entities.ts. It is here you'll setup your TypeScript interfaces.

Contributing

  • creat and issue, i'll review it, (review could take as long as 3days, depending on the issue).
  • If it's ok, you can then work on it, the create PRs to the dev branch.
  • Your PR should be titled feature/< your fix(as shoten as possible):your github-username >.
  • Donnot or attempt force pushing.
  • Donnot push your local test branches or any branches your created that donnot follow this format, and or have anything to do with your fix

Deployment

  • Render

    • hello world

node-express-js-template's People

Contributors

rashjredmund avatar

Watchers

 avatar

node-express-js-template's Issues

setup the abitlity to use the fs module as a database too.

This is going to be for instances where the project does not necessarily require a database like mongo or mySql.

It's to be a class with specially pre-written methods that'll tap into the fs-module and access files within the project

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.