Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
![Super Easy Forms](img/arjan-header.png) | ||
|
||
[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://gkpty.mit-license.org) | ||
|
||
Arjan is a CLI that allows you deploy microservices easily. When you deploy resources you also save them in a JSON file that can be easily parsed and read by the CLI, enabling you to connect your resources. | ||
|
||
**Some Basic Actions Arjan will help you complete** | ||
- API | ||
- Deploy API | ||
- Deploy method | ||
- Enable CORS | ||
- Website | ||
- Deploy public site | ||
- Deploy www reroute bucket | ||
- CDN | ||
- Deploy cloudfront | ||
- Deploy cloudflare | ||
- Email endpoint | ||
- Add gmail account | ||
- Validate email with SES account | ||
- unctions | ||
- Deploy lambda function from template | ||
- Deploy lambda function from a file | ||
- Database | ||
- Deploy a NoSQL DB table | ||
- Deploy a SQL DB table (amazon aurora only) | ||
|
||
|
||
## Pre-requisites | ||
|
||
* Make sure you have node.js and npm installed. You can checkout this [tutorial](https://medium.com/@lucaskay/install-node-and-npm-using-nvm-in-mac-or-linux-ubuntu-f0c85153e173) to install npm and node in mac, linux (debian/ubuntu). | ||
* Have an AWS account and an IAM user with administrator access. If you don't have an AWS account, you can easily create one [here](https://portal.aws.amazon.com/billing/signup?#/start). Don't worry, everything you do with this project will fall within the AWS free tier limit! | ||
|
||
## Steps | ||
1. Clone the repository | ||
2. Go into the directory of the project ` cd super_easy_forms ` | ||
3. create a file called .env and add the following variables. replace your-acces-key and your-secret-access-key with the keys that were displayed when you created the IAM user. | ||
``` | ||
AWS_ACCESS_KEY_ID=your-access-key | ||
AWS_SECRET_ACCESS_KEY=your-secret-access-key | ||
AWS_REGION=us-east-1 | ||
AWS_ACCOUNT_NUMBER=your-aws-account-number | ||
``` | ||
4. To find your AWS account number, go to the [AWS console support center](https://console.aws.amazon.com/support/home?) | ||
![image 18](img/account_number.png) | ||
5. Install all dependencies by running ` npm install` | ||
6. Start the CLI by running ` node super-easy-forms.js ` | ||
|
||
**Labels** : Form fields must be one word. you can use - or _ to unite words for example you can use `first_name` or `first-name` and the label will automatically get split into first name. | ||
|
||
**Field Types** : By default form fields will be set as text inputs. to use a textfield instead include the word message. For an input type email include the word email and for an input type number include the word number. | ||
|
File renamed without changes.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.