https://github.com/jamg44/nodetyped

Node.js Express Startup Seed with ES6, Typescript, SCSS, EJS, Nodemon, Bootstrap 4, TSLint, TypeDoc
https://github.com/jamg44/nodetyped

bootstrap4 ejs express jasmine jsdoc nodemon scss typescript

Last synced: 4 months ago
JSON representation

Node.js Express Startup Seed with ES6, Typescript, SCSS, EJS, Nodemon, Bootstrap 4, TSLint, TypeDoc

• Host: GitHub
• URL: https://github.com/jamg44/nodetyped
• Owner: jamg44
• License: mit
• Created: 2016-04-10T12:34:21.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-06-05T18:09:20.000Z (over 6 years ago)
• Last Synced: 2024-09-27T16:20:57.031Z (4 months ago)
• Topics: bootstrap4, ejs, express, jasmine, jsdoc, nodemon, scss, typescript
• Language: TypeScript
• Homepage:
• Size: 181 KB
• Stars: 71
• Watchers: 13
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NodeTyped

> A Node.js starter kit featuring ES6 with **Secuential Asynchrony (async/await)**,

[Express](http://expressjs.com/) (Routing middlewares, Web, Api),

[Typescript](http://www.typescriptlang.org/),

[Mongoose](http://mongoosejs.com/),

[SCSS](http://sass-lang.com/),

[EJS](https://github.com/mde/ejs),

[Nodemon](http://nodemon.io/),

[Bootstrap 4](https://getbootstrap.com/),

[TSLint](https://palantir.github.io/tslint/),

[TypeDoc](https://github.com/TypeStrong/typedoc),

.

* Simple npm setup and maintenance, without grunt/gulp/webpack/...

* Support for async/await

Example middleware:

```javascript

async function(req, res, next) {

    let title = 'NodeTyped Express';

    try {

        let data = await readFile(file, 'utf-8');

        res.render('index', { title: title, dump: data });

    } catch (e) {

        next(e);

    }

}

```

## Requirements

Make sure **you have node version >= 8.0**

### Clone and Install dependencies

```bash

# clone the repo

# --depth 1 removes all but one .git commit history

git clone --depth 1 https://github.com/jamg44/NodeTyped.git projectname

# change directory to your new project

cd projectname

# install the repo dependencies with npm

npm install

# start the server

npm run dev

```

If you want to use mongoose models, start mongodb, check localConfig.js and:

```bash

# load sample products in database (defaults to 'test')

npm run loadMocks

```

## Develop

### Watch mode

You can start the server in development mode (linter included) with:

```bash

npm run dev

```

Open the browser at:

* http://localhost:3000

Start MongoDB, run 'npm run loadMocks', and check:

* http://localhost:3000/products

* http://localhost:3000/apiv1/products

* http://localhost:3000/apiv1/products/near/(meters)/lon/(lon)/lat/(lat)

As you save in your editor, the compiler will rebuild and restart the server.

### Other commands

Run the linter manually:

```bash

npm run lint

```

Clean temp folders:

```bash

npm run clean

```

Run the tests:

```bash

npm test

```

Generate docs, the output will be in /doc folder:

```bash

npm run doc

```

## Production / Integration

To run the project in a server you'll want to run the built code instead src version.

```bash

# deploy the repo to server and run

npm install

npm start

```

## Recommendations

* To change project name update package.json

```bash

"name": "project_name", <-----

...

"dev": "tsc && DEBUG=project_name2:* ... <-----

```

* All your functions should return promises for better use with async/await.

```bash

let readFile = function(file, encoding) => {

    return new Promise((resolve, reject) => {

        fs.readFile(file, encoding, function(err, data) {

            if (err) {

                return reject(err);

            }

            resolve(data);

        });

    });

};

```

## Roadmap (TODO)

* API authentication with [JWT](https://jwt.io/)

* Add cluster

* User system (register, login, etc)

* Add tests

* Basic panel

## License

 [MIT](/LICENSE)

Made with ♡ by Javier Miguel González @javiermiguelg