From 8652f52221413b2ccda1eed3e3b7876e17f29640 Mon Sep 17 00:00:00 2001
From: Alejandro Lembke Barrientos <aleleba@hotmail.com>
Date: Thu, 26 May 2022 00:02:22 +0000
Subject: [PATCH] PR-448199: Adding Readme file.

---
 README.md    | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 bin/cli.js   |  2 +-
 package.json |  2 +-
 3 files changed, 75 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..48b8306
--- /dev/null
+++ b/README.md
@@ -0,0 +1,73 @@
+# Create Node TS GraphQL Server
+
+This project aims to have a starter kit for creating a new Node with typescript, GraphQl server and tools that generally go along with it.
+
+Tech(Library or Framework) | Version |
+--- | --- |
+Jest (Testing) | 28.1.0
+Typescript | 4.7.2
+
+## Setup
+To create a new project run in the terminal:
+```
+npx @aleleba/create-node-ts-graphql-server server-app-name
+```
+Then run:
+```
+cd server-app-name
+```
+You will need to create a new .env file at the root of the project for global config.
+This is an example of config.
+```
+#ENVIRONMENT Defauld production
+ENVIRONMENT=development
+#WHITELIST URLS Default to http://localhost
+WHITELIST_URLS=https://dev-back-end.p-lao.com
+#GRAPHIQL Default to "false"
+GRAPHIQL=true
+# PORT EXPOSE APP Default to 4000
+PORT=4000
+```
+The default environment is production, the server-app port defauld is 4000, the default whitelist is http://localhost and the default graphiql is false.
+
+### For Development
+In the terminal run:
+```
+npm run start:dev
+```
+The ENV enviroment variable should be "development" and choose the port of your preference with the enviroment variable PORT.
+
+You will find the controllers on:
+```
+scr/controllers/
+```
+You will find the models on:
+```
+scr/models
+```
+You will find the GraphQL server, resolvers and schema definition on:
+```
+scr/GraphQL
+```
+
+The manage of the routes for custom API you should find on:
+```
+scr/routes
+```
+
+This will start the app in development mode, also use nodemon and webpack to real time coding!
+Enjoy coding!
+
+### For Production
+In the terminal run:
+```
+npm run build
+```
+It will create a build folder and run:
+```
+npm start
+```
+This will start the app.
+
+## Cheers
+Hope you enjoy this proyect! Sincerely Alejandro Lembke Barrientos.
\ No newline at end of file
diff --git a/bin/cli.js b/bin/cli.js
index 5fe5e35..c448067 100644
--- a/bin/cli.js
+++ b/bin/cli.js
@@ -12,7 +12,7 @@ const runCommand = command => {
 }
 
 const repoName = process.argv[2];
-const gitCheckoutCommand = `git clone --depth 1 https://github.com/aleleba/node-ts-graphql-server ${repoName}`;
+const gitCheckoutCommand = `git clone --depth 1 https://github.com/aleleba/create-node-ts-graphql-server ${repoName}`;
 const installDepsCommand = `cd ${repoName} && npm install`;
 
 console.log(`Cloning the repository with name ${repoName}`);
diff --git a/package.json b/package.json
index a240344..cddb83f 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ts-graphql-server",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "Node with Typescript and GraphQL Server",
   "bin": "./bin/cli.js",
   "main": "index.js",