Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ghiscoding/realtime-todo-aurelia-auth-rethinkdb
A realtime TODO App with Aurelia, NodeJS and RethinkDB
https://github.com/ghiscoding/realtime-todo-aurelia-auth-rethinkdb
aurelia koa nodejs realtime realtime-todo rethinkdb socket
Last synced: 3 months ago
JSON representation
A realtime TODO App with Aurelia, NodeJS and RethinkDB
- Host: GitHub
- URL: https://github.com/ghiscoding/realtime-todo-aurelia-auth-rethinkdb
- Owner: ghiscoding
- License: mit
- Created: 2016-05-10T06:28:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-06-07T21:19:00.000Z (over 2 years ago)
- Last Synced: 2024-10-11T20:46:07.298Z (4 months ago)
- Topics: aurelia, koa, nodejs, realtime, realtime-todo, rethinkdb, socket
- Language: TypeScript
- Homepage:
- Size: 1.31 MB
- Stars: 7
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-license.txt
Awesome Lists containing this project
README
A Realtime TODO App with [Aurelia](http://aurelia.io), [Socket.IO](http://socket.io/), [Node.js](http://www.nodejs.org/), [Koa](http://koajs.com/) and [RethinkDB](https://www.rethinkdb.com/).
A summary of tech stack:
* **Client**: [Aurelia](http://aurelia.io/), [Bootstrap 4](http://getbootstrap.com/), [Font-Awesome](http://fontawesome.io/) and [Aurelia-Bootstrap-Plugins](https://github.com/ghiscoding/Aurelia-Bootstrap-Plugins) ...my own creation :smile:.
* **Server**: [Koa 2](http://koajs.com/) for RESTful API serving on [Node.js](https://nodejs.org/).
* **[Socket.IO](http://socket.io/)** along with JSON-RPC is used for real-time client-server communication and browser sync.
* **[RethinkDB](https://rethinkdb.com/)** as the best open-source database for the realtime web.
* **[TypeScript](https://www.typescriptlang.org)** is used for both Aurelia & NodeJS sides
## Getting Started
Make sure to have [Node.js](https://nodejs.org/) v8.x or higher, and [RethinkDB](https://rethinkdb.com/) v2.3.x or higher installed on your computer.
### Git Clone (downloading)
```bash
git clone https://github.com/ghiscoding/Realtime-TODO-Aurelia-Auth-RethinkDB
```
### OAuth Authentication with Aurelia-Auth
We will use [Aurelia-Auth](https://github.com/paulvanbladel/aurelia-auth) for OAuth login so that we can use (Google, Facebook, GitHub, LinkedIn, Windows Live or Twitter) to login to our application. The configuration of the OAuth secret keys will be under `server/config/config.development.js`, this file is however excluded from the project (for obvious reason).
**A very important step to do, go under the folder `/server/config` and rename the file from `config.development.template.js` to `config.development.js` and then fill in your OAuth secret keys.**
The `Aurelia-Auth`is based on `Satellizer` and uses the same configurations, so you could refer to their [GitHub Satellizer](https://github.com/sahat/satellizer) repo for more details.
### Database (RethinkDB)
We are using RethinkDB as our favorite NoSQL DB Server, you can use the default port of `28015`.
Also make sure to create a `test` database (if not yet created) with the following tables (`todos`, `users`, `customers`).
### Client (TypeScript WebPack 3.x)
Please note that the `TypeScript Webpack` with the command line `npm start` will ONLY run the WebUI (Aurelia).
#### Install/Run trough shell
If you want to run both the frontend/backend (WebUI w/Aurelia + WebAPI w/NodeJS), you can do so by calling `npm start -- withBackend` (make sure to follow the [Server installation](#server-nodejs---koa) prior to launching this command).
```bash
cd Realtime-TODO-Aurelia-Auth-RethinkDB
npm install # or: yarn install
npm start withBackend # or: yarn start withBackend
```
#### Install/Run through VSCode
If you use VSCode (Visual Studio Code) as your main editor, you can simply load the folder. Once loaded, you can then click on `Tasks` and then have access to multiple tasks (defined in `.vscode/tasks.json`) which makes it easy to execute the code without even typing any command in the shell (starting any of the Task `Starting X` task(s) will also run `npm install` or `yarn install` prior to run).
##### Note on Default Packager
You can change the Default Packager to your liking by editing the `config.js` file with the packager you wish to use
```javascript
// config.js
module.exports = {
webUiPort: 4000,
webApiPort: 5000,
packager: 'yarn' // you can use 'npm or 'yarn'
}
```
### Server (NodeJS - KOA)
**Optional, see the note below**
```bash
cd Realtime-TODO-Aurelia-Auth-RethinkDB/server
npm install # or: yarn install
npm start # or: yarn start
```
_**Note**: running the server here is totally optional, since you might have already started it with the `backend` flag with CLI client or ` withBackend` to run both servers._
## Web UI
If everything goes well, your application should now run locally on port `4000`. Open your browser and go to the URL [http://localhost:4000](http://localhost:4000).
## Configuration
### Server
Server configurations are specified in the [/server/config](https://github.com/ghiscoding/Realtime-TODO-Aurelia-Auth-RethinkDB/blob/master/config.js) directory. When running `npm start` it will load the configuration that is defined in your `process.env.NODE_ENV` (environment variable, if unset it will use `development` by default).
### Default Ports
Default ports for this application are `4000` for the WebUI and `5000` for the API (server) calls.
You can change these ports by going into the [config.js](https://github.com/ghiscoding/Realtime-TODO-Aurelia-Auth-RethinkDB/blob/master/config.js) that is located in the root of the project.
#### WebPack with TypeScript
Please note that the `webpack.config.js` and `package-scripts.js` were modifed to use the `config.js` to make it easier to configure.
## Contributions
Contributions are welcome. I use this project as a placeholder to help (and be helped by) people, which is all about the open community. So please feel free to make any PR (Pull Request).
## License
MIT