Giter Club home page Giter Club logo

metu-course-finder's Introduction


Maintained with Lerna License

Overview

TEN stack is a Typescript + Express + Node starter kit to develop REST API server apps. Nothing new under the sun, just a straight forward combo to make server development a little bit faster. And of course, this make my freelancing days more enjoyable 😎 Comes with:


Prerequisites

Install

  • Fork or Use this template repository.
  • Clone the forked repository.
  • Install the dependencies with yarn or npm.

Make sure you already have node.js and npm or yarn installed in your system.

  • Set your git remote add origin path
 git remote add origin ${forked-and-cloned-path}

Update the url if you already have an origin



Config

  • Copy .env.example a file at the root of the application.
  • Add or modify specific variables and update it according to your need.
 cp .env.example .env

Check the config folder to customize your settings (/src/config)



Alias @

To make paths clean and ease to access @ is setup up for /src path

// BEFORE
import config from './config';
import routes from './routes';

// NOW
import config from '@/config';
import routes from '@/routes';

You can customize this setup: /tsconfig.json > compilerOptions.paths /eslintrc.yml > rules.settings.alias.map



Local Development

Run the server locally. It will be run with Nodemon and ready to serve on port 8080 (unless you specify it on your .env)

 yarn start # or npm start

Check package.json to see more "scripts"



Production

First, build the application.

 yarn build # or npm run build

Then, use pm2 to start the application as a service.

 yarn service:start # or npm run service:start


Contribution

This repository will be managed as an open-source.
Please feel free to open an issue or a pull request to suggest changes or additions.

Support & Contact

If you have any question or suggestion, don't hesitate to contact me:

✉️ [email protected]

🎧 I was listening this playlist to boost my productivity!

Author & Credits

metu-course-finder's People

Contributors

filoscoder avatar sahin52 avatar

Watchers

 avatar

metu-course-finder's Issues

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.