Canary Merge

.prettierrc

@@ -1,6 +1,6 @@
 {
     "trailingComma": "es5",
     "tabWidth": 4,
-    "semi": true,
+    "semi": false,
     "singleQuote": true
 }

README.md

@@ -2,19 +2,23 @@
 
 A minimal file tree based api router for building rest api's with node.
 
-### Motivation
+### About
 
-I'm one of the many people who use [Next.js(Vercel)](https://github.com/vercel/next.js) and while the whole framework is great, I'm a huge fan of the API routes mechanism and thought I'd implement my own version of it so I can continue having seperate backend and frontend code while having the ease of writing api routes also, wanted to learn how this stuff works. (I'm curious like that).
+RouteX started as a clone of the Next.js' Api Routes implmentation and is now on it's path to compete with other frameworks as the simplest way to setup API routes. There's been numerous posts on why using the folder tree makes it atomic and easier to handle the separation between logic. While you cannot bundle code with routex since each file is independent of the other and doesn't need the others for its execution.
 
-### Roadmap (as of now)
+The Idea and Inspiration for the creation remains to be Vercel's Next.js
 
--   [x] Start of simple with something that can handle static routes.(Master and Canary)
--   [x] Add CLI tool to be used with it (Master and Canary)
--   [x] Add Dynamic paths and parameter parsing. (Canary Only)
--   [x] Add minimal request and response helpers.
--   [ ] Add more features to CLI (reloading, watchers, etc, etc)
+### Changes (6/Jul/2020)
 
-That's all I want the `routex` to do for now.
+-   Removed the `.route` folder for storing the compiled routes
+-   Root Folder routes are now accessible, you don't need to specifically use an `api` folder anymore, you can use any folder and the cli will consider it a route. Check CLI Commands before to achieve this.
+-   CLI flag for custom port added to avoid using the general environment variable
+
+### Performace
+
+Screenshot of `autocannon` to benchmark `/api` from the examples folder
+
+![GitHub Logo](/docs/perf.png)
 
 ### Warning
 
@@ -24,20 +28,32 @@ This library is still in active development and is bound to have bugs , kindly m
 
 -   A very limited cli, no hot reload, no file watcher, it literally just runs a simple processor for reading the file system as of now.
 
--   Since the lib uses the native node HTTP right now, you are limited to it's request and response functions.
-
-### Usage
+### Installation
 
-Any file inside the folder `api` is mapped to `/api/*` and will be treated as an API endpoint and all HTTP requests will be passed to this file. GET, POST, PUT, DELETE
+#### Stable Cli
 
 ```sh
 # for global install to avoid installing the devDependencies
 npm i -g barelyhuman/routex --only=prod
 # for local install to avoid installing the devDependencies
 npm i barelyhuman/routex --only=prod
+
+```
+
+#### Canary Cli
+
+```sh
+# for global install to avoid installing the devDependencies
+npm i -g barelyhuman/routex#canary --only=prod
+# for local install to avoid installing the devDependencies
+npm i barelyhuman/routex#canary --only=prod
 ```
 
-Then go ahead and create directories and files under the `api` folder as mentioned or check the `examples` folder for reference.
+### Usage
+
+Any folder that routex is run in will be considered the API root and will look for an `api` folder in the run location.
+
+Then go ahead and create directories and files under any folder as mentioned or check the `examples` folder for reference.
 
 Example file tree:
 
@@ -78,7 +94,7 @@ module.exports = (req, res) => {
 
 ```
 
-Then run routex on the root folder of the project, this folder should contain the `api` folder
+Then run routex on the root folder of the project, this folder should contain the `api` folder or specify a directory using the `-d` or `--dir` command.
 
 ```sh
 # If installed globally
@@ -88,8 +104,14 @@ npx routex
 
 ```
 
-### Rules
+### CLI Commands
 
--   No copying of code from Next.js
--   Don't use micro, setup and parse node http from scratch
--   Try to keep it 0 Deps.
+-   `-d | --dir` to specify the directory to be used for routes, defaults to `api`
+-   `-p | --port` to specify the port to start the http server on , defaults to `3000`
+
+Example, the following would use the `example` folder as the base path for the routes and start the server on port `3001`
+
+```sh
+  routex -d ./example -p 3001
+
+```

app.js

@@ -1,14 +1,21 @@
 #!/usr/bin/env node
 
-const microServer = require('./lib/micro-server');
-const setupRoutes = require('./lib/setup-routes');
-const http = require('http');
-const PORT = process.env.PORT || 3000;
+const microServer = require('./lib/micro-server')
+const setupRoutes = require('./lib/setup-routes')
+const http = require('http')
 
-setupRoutes();
+const argv = require('minimist')(process.argv.slice(2))
+const port = argv.p || argv.port || 3000
 
-http.createServer((req, res) => {
-    microServer(req, res);
-}).listen(PORT, () => {
-    console.log('> Listening on ' + PORT);
-});
+setupRoutes()
+    .then((availableRoutes) => {
+        http.createServer((req, res) => {
+            microServer(req, res, availableRoutes)
+        }).listen(port, () => {
+            console.log('> Listening on ' + port)
+        })
+    })
+    .catch((err) => {
+        console.log(err)
+        throw err
+    })

create-docs.js

@@ -1,10 +1,10 @@
-const fs = require('fs').promises;
-const marked = require('marked');
+const fs = require('fs').promises
+const marked = require('marked')
 
 async function main() {
     try {
-        const fileMarkdownString = await fs.readFile('README.md');
-        const htmlString = marked(fileMarkdownString.toString());
+        const fileMarkdownString = await fs.readFile('README.md')
+        const htmlString = marked(fileMarkdownString.toString())
         const template = `
         <!DOCTYPE html>
         <html lang="en">
@@ -23,13 +23,13 @@ async function main() {
               ${htmlString}
             </body>
         </html>    
-        `;
+        `
 
-        await fs.writeFile('docs/index.html', template);
+        await fs.writeFile('docs/index.html', template)
     } catch (err) {
-        console.error(err);
-        throw err;
+        console.error(err)
+        throw err
     }
 }
 
-main();
+main()