-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from Bashamega/website
Added Documentation
- Loading branch information
Showing
15 changed files
with
451 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
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,61 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <title>April | Documentation</title> | ||
| <link rel="stylesheet" href="../../style.css"> | ||
| </head> | ||
| <body> | ||
| <nav> | ||
| <ul class="nav-list"> | ||
| <li> | ||
| <a href="../../index.html" >About</a> | ||
| </li> | ||
| <li><a href="../gettingstarted/">Getting Started</a></li> | ||
| <li class="active"><a href="../cmdExamples/">Commandline examples</a></li> | ||
| <li><a href="../key/">Key Words</a></li> | ||
| <li><a href="../general/">General Commands</a></li> | ||
| <li><a href="../properties/">Properties</a></li> | ||
| <li><a href="../import/">Importing</a></li> | ||
| <li><a href="../newpackage/">Creating new package</a></li> | ||
| <li><a href="../commenting/">Commenting</a></li> | ||
| <li><a href="../packages/">Packages</a></li> | ||
| <li><a href="../contributing/">Contibuting</a></li> | ||
| <li><a href="../support/">Support</a></li> | ||
| <li><a href="../author/">Author</a></li> | ||
| <li><a href="../license/">License</a></li> | ||
| </ul> | ||
| </nav> | ||
| <main> | ||
| <div class="theme-switcher"> | ||
| <span id="toggle-icon" class="light-mode"></span> | ||
| <label class="switch"> | ||
| <input type="checkbox" id="theme-toggle"> | ||
| <span class="slider round"></span> | ||
| </label> | ||
| </div> | ||
| <h1>Commandline examples</h1> | ||
| <div class="content"> | ||
| <p>Get the list of allowed commands</p> | ||
| <div class="codeSnippet">april -h</div> | ||
| <p>Get info of the language</p> | ||
| <div class="codeSnippet">april -a</div> | ||
| <p>Compile an .apl file (april file):</p> | ||
| <ul> | ||
| <li>This converts the april code to python3 code</li> | ||
| <li>Compiled file is saved as filename without extention apl + '_apl.py'</li> | ||
| </ul> | ||
| <div class="codeSnippet">april -c file.apl</div> | ||
| <p>Run an .apl file (start the API server):</p> | ||
| <ul> | ||
| <li>Format for the command is - april -r host:port</li> | ||
| </ul> | ||
| <div class="codeSnippet">april -r file.apl 0.0.0.0:8080</div> | ||
| <p>Get the version of april:</p> | ||
| <div class="codeSnippet">april -v</div> | ||
| </div> | ||
| </main> | ||
| <script src="../../script.js"></script> | ||
| </body> | ||
| </html> |
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,55 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <title>April | Documentation</title> | ||
| <link rel="stylesheet" href="../../style.css"> | ||
| </head> | ||
| <body> | ||
| <nav> | ||
| <ul class="nav-list"> | ||
| <li> | ||
| <a href="../../index.html" >About</a> | ||
| </li> | ||
| <li><a href="../gettingstarted/">Getting Started</a></li> | ||
| <li><a href="../cmdExamples/">Commandline examples</a></li> | ||
| <li><a href="../key/">Key Words</a></li> | ||
| <li><a href="../general/">General Commands</a></li> | ||
| <li><a href="../properties/">Properties</a></li> | ||
| <li><a href="../import/">Importing</a></li> | ||
| <li><a href="../newpackage/">Creating new package</a></li> | ||
| <li class="active"><a href="../commenting/">Commenting</a></li> | ||
| <li><a href="../packages/">Packages</a></li> | ||
| <li><a href="../contributing/">Contibuting</a></li> | ||
| <li><a href="../support/">Support</a></li> | ||
| <li><a href="../author/">Author</a></li> | ||
| <li><a href="../license/">License</a></li> | ||
| </ul> | ||
| </nav> | ||
| <main> | ||
| <div class="theme-switcher"> | ||
| <span id="toggle-icon" class="light-mode"></span> | ||
| <label class="switch"> | ||
| <input type="checkbox" id="theme-toggle"> | ||
| <span class="slider round"></span> | ||
| </label> | ||
| </div> | ||
| <h1>License</h1> | ||
| <div class="content"> | ||
| <ul> | ||
| <li>This can be done by using '//'</li> | ||
| <li>There is only single line commenting</li> | ||
| </ul> | ||
| <h2>Example:</h2> | ||
| <div class="codeSnippet"> | ||
| // Program 1 | ||
| <br> | ||
| <br> | ||
| IMPORT X // importing x | ||
| </div> | ||
| </div> | ||
| </main> | ||
| <script src="../../script.js"></script> | ||
| </body> | ||
| </html> |
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
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,55 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <title>April | Documentation</title> | ||
| <link rel="stylesheet" href="../../style.css"> | ||
| </head> | ||
| <body> | ||
| <nav> | ||
| <ul class="nav-list"> | ||
| <li> | ||
| <a href="../../index.html" >About</a> | ||
| </li> | ||
| <li><a href="../gettingstarted/">Getting Started</a></li> | ||
| <li><a href="../cmdExamples/">Commandline examples</a></li> | ||
| <li><a href="../key/">Key Words</a></li> | ||
| <li class="active"><a href="../general/">General Commands</a></li> | ||
| <li><a href="../properties/">Properties</a></li> | ||
| <li><a href="../import/">Importing</a></li> | ||
| <li><a href="../newpackage/">Creating new package</a></li> | ||
| <li><a href="../commenting/">Commenting</a></li> | ||
| <li><a href="../packages/">Packages</a></li> | ||
| <li><a href="../contributing/">Contibuting</a></li> | ||
| <li><a href="../support/">Support</a></li> | ||
| <li><a href="../author/">Author</a></li> | ||
| <li><a href="../license/">License</a></li> | ||
| </ul> | ||
| </nav> | ||
| <main> | ||
| <div class="theme-switcher"> | ||
| <span id="toggle-icon" class="light-mode"></span> | ||
| <label class="switch"> | ||
| <input type="checkbox" id="theme-toggle"> | ||
| <span class="slider round"></span> | ||
| </label> | ||
| </div> | ||
| <h1>License</h1> | ||
| <div class="content"> | ||
| <ul><li>General format:</li></ul> | ||
| <p><request_type eg: get,post..>(<the api endpoint, use '{var-name}' when there is a variable in the endpoint url eg: '/home/page/{}'>) : | ||
| </p> | ||
| <h3>Examples</h3> | ||
| <h4>Making a GET end point:</h4> | ||
| <div class="codeSnippet">get('/home') : python3 home.py</div> | ||
| <h4>Making a Get endpoint with 1/more variables:</h4> | ||
| <div class="codeSnippet">get('/home/page/{x}/para/{y}') : python3 home.py</div> | ||
| <p>Then the rest is done with the help of packages made for integrating april with them. You can find the list of packages <a href="../packages/">here</a>.</p> | ||
|
|
||
|
|
||
| </div> | ||
| </main> | ||
| <script src="../../script.js"></script> | ||
| </body> | ||
| </html> |
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
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,58 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <title>April | Documentation</title> | ||
| <link rel="stylesheet" href="../../style.css"> | ||
| </head> | ||
| <body> | ||
| <nav> | ||
| <ul class="nav-list"> | ||
| <li> | ||
| <a href="../../index.html" >About</a> | ||
| </li> | ||
| <li><a href="../gettingstarted/">Getting Started</a></li> | ||
| <li><a href="../cmdExamples/">Commandline examples</a></li> | ||
| <li><a href="../key/">Key Words</a></li> | ||
| <li><a href="../general/">General Commands</a></li> | ||
| <li><a href="../properties/">Properties</a></li> | ||
| <li class="active"><a href="../import/">Importing</a></li> | ||
| <li><a href="../newpackage/">Creating new package</a></li> | ||
| <li><a href="../commenting/">Commenting</a></li> | ||
| <li><a href="../packages/">Packages</a></li> | ||
| <li><a href="../contributing/">Contibuting</a></li> | ||
| <li><a href="../support/">Support</a></li> | ||
| <li><a href="../author/">Author</a></li> | ||
| <li><a href="#">License</a></li> | ||
| </ul> | ||
| </nav> | ||
| <main> | ||
| <div class="theme-switcher"> | ||
| <span id="toggle-icon" class="light-mode"></span> | ||
| <label class="switch"> | ||
| <input type="checkbox" id="theme-toggle"> | ||
| <span class="slider round"></span> | ||
| </label> | ||
| </div> | ||
| <h1>Import</h1> | ||
| <div class="content"> | ||
| <ul> | ||
| <li>You can import other april files into an april program | ||
| </li> | ||
| <li>Importing an other apl code would ignore the keyword commands from the imported file | ||
| </li> | ||
| <li>Importing can be used to apply the same endpoints in your apl file | ||
| </li> | ||
| <li>You just need to mention the file name without extention | ||
| </li> | ||
| <li>The file should be saved with an .apl extention | ||
| </li> | ||
| </ul> | ||
| <h3>Example:</h3> | ||
| <div class="codeSnippet">IMPORT code // the imported code should be saved as code.apl</div> | ||
| </div> | ||
| </main> | ||
| <script src="../../script.js"></script> | ||
| </body> | ||
| </html> |
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,69 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <title>April | Documentation</title> | ||
| <link rel="stylesheet" href="../../style.css"> | ||
| </head> | ||
| <body> | ||
| <nav> | ||
| <ul class="nav-list"> | ||
| <li> | ||
| <a href="../../index.html" >About</a> | ||
| </li> | ||
| <li><a href="../gettingstarted/">Getting Started</a></li> | ||
| <li><a href="../cmdExamples/">Commandline examples</a></li> | ||
| <li class="active"><a href="../key/">Key Words</a></li> | ||
| <li><a href="../general/">General Commands</a></li> | ||
| <li><a href="../properties/">Properties</a></li> | ||
| <li><a href="../import/">Importing</a></li> | ||
| <li><a href="../newpackage/">Creating new package</a></li> | ||
| <li><a href="../commenting/">Commenting</a></li> | ||
| <li><a href="../packages/">Packages</a></li> | ||
| <li><a href="../contributing/">Contibuting</a></li> | ||
| <li><a href="../support/">Support</a></li> | ||
| <li><a href="../author/">Author</a></li> | ||
| <li><a href="../license/">License</a></li> | ||
| </ul> | ||
| </nav> | ||
| <main> | ||
| <div class="theme-switcher"> | ||
| <span id="toggle-icon" class="light-mode"></span> | ||
| <label class="switch"> | ||
| <input type="checkbox" id="theme-toggle"> | ||
| <span class="slider round"></span> | ||
| </label> | ||
| </div> | ||
| <h1>Keyword commands</h1> | ||
| <div class="content"> | ||
| <ul dir="auto"> | ||
| <li> | ||
| <p dir="auto">Generate Documentation ( 'GEN_DOC {eg : /e/e/doc }' )</p> | ||
| </li> | ||
| <li> | ||
| <p dir="auto">Rate Limiting ( 'RATE_LIMIT {how many per min}' )</p> | ||
| </li> | ||
| <li> | ||
| <p dir="auto">Disallow Private IP ( 'DISALLOW_PRIVATE_IP' )</p> | ||
| </li> | ||
| <li> | ||
| <p dir="auto">Not Allowed IP ( 'NOT_ALLOWED_IP {textfile.txt each ip sep by \n}' )</p> | ||
| </li> | ||
| <li> | ||
| <p dir="auto">Import april files ( 'IMPORT {filename}' )</p> | ||
| </li> | ||
| <li> | ||
| <p dir="auto">Other keywords:</p> | ||
| <ul dir="auto"> | ||
| <li>TITLE '{}'</li> | ||
| <li>VERSION {}</li> | ||
| <li>DESC '{}'</li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </main> | ||
| <script src="../../script.js"></script> | ||
| </body> | ||
| </html> |
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
Oops, something went wrong.