Project setup
This commit is contained in:
		
							parent
							
								
									736c1b208b
								
							
						
					
					
						commit
						20cf4e0731
					
				
							
								
								
									
										2
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							@ -1,7 +1,7 @@
 | 
				
			|||||||
# ---> Romulus-JS
 | 
					# ---> Romulus-JS
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Build output
 | 
					# Build output
 | 
				
			||||||
lib/
 | 
					dist/
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# ---> VisualStudioCode
 | 
					# ---> VisualStudioCode
 | 
				
			||||||
.vscode/*
 | 
					.vscode/*
 | 
				
			||||||
 | 
				
			|||||||
							
								
								
									
										5
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										5
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@ -0,0 +1,5 @@
 | 
				
			|||||||
 | 
					{
 | 
				
			||||||
 | 
					    "recommendations": [
 | 
				
			||||||
 | 
					        "orta.vscode-jest"
 | 
				
			||||||
 | 
					    ]
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
							
								
								
									
										10
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								README.md
									
									
									
									
									
								
							@ -4,7 +4,15 @@ An implementation of the Romulus-M cryptography specification.
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Build
 | 
					## Build
 | 
				
			||||||
 | 
					
 | 
				
			||||||
_Build instructions coming soon._
 | 
					To build the Romulus-JS library, first clone this repository.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Run the following commands from the root of the repository:
 | 
				
			||||||
 | 
					```bash
 | 
				
			||||||
 | 
					$ npm install
 | 
				
			||||||
 | 
					$ npm run build
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					The build output will be saved to the `lib` directory.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Visual Studio Code
 | 
					### Visual Studio Code
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
							
								
								
									
										6006
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										6006
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										14
									
								
								package.json
									
									
									
									
									
								
							
							
						
						
									
										14
									
								
								package.json
									
									
									
									
									
								
							@ -4,7 +4,8 @@
 | 
				
			|||||||
  "description": "An implementation of the Romulus-M cryptography specification.",
 | 
					  "description": "An implementation of the Romulus-M cryptography specification.",
 | 
				
			||||||
  "main": "index.js",
 | 
					  "main": "index.js",
 | 
				
			||||||
  "scripts": {
 | 
					  "scripts": {
 | 
				
			||||||
    "test": "echo \"Error: no test specified\" && exit 1"
 | 
					    "test": "jest",
 | 
				
			||||||
 | 
					    "build": "tsc"
 | 
				
			||||||
  },
 | 
					  },
 | 
				
			||||||
  "repository": {
 | 
					  "repository": {
 | 
				
			||||||
    "type": "git",
 | 
					    "type": "git",
 | 
				
			||||||
@ -13,7 +14,16 @@
 | 
				
			|||||||
  "author": "Butlersaurus",
 | 
					  "author": "Butlersaurus",
 | 
				
			||||||
  "license": "ISC",
 | 
					  "license": "ISC",
 | 
				
			||||||
  "devDependencies": {
 | 
					  "devDependencies": {
 | 
				
			||||||
 | 
					    "typescript": "^4.5.5",
 | 
				
			||||||
    "ts-standard": "^11.0.0",
 | 
					    "ts-standard": "^11.0.0",
 | 
				
			||||||
    "typescript": "^4.5.5"
 | 
					    "jest": "^27.4.7",
 | 
				
			||||||
 | 
					    "ts-jest": "^27.1.3",
 | 
				
			||||||
 | 
					    "@types/jest": "^27.4.0"
 | 
				
			||||||
 | 
					  },
 | 
				
			||||||
 | 
					  "jest": {
 | 
				
			||||||
 | 
					    "verbose": true,
 | 
				
			||||||
 | 
					    "transform": {
 | 
				
			||||||
 | 
					      "^.+\\.ts?$": "ts-jest"
 | 
				
			||||||
 | 
					    }
 | 
				
			||||||
  }
 | 
					  }
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 | 
				
			|||||||
@ -47,7 +47,7 @@
 | 
				
			|||||||
    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
 | 
					    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
 | 
				
			||||||
    "sourceMap": true,                                   /* Create source map files for emitted JavaScript files. */
 | 
					    "sourceMap": true,                                   /* Create source map files for emitted JavaScript files. */
 | 
				
			||||||
    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
 | 
					    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
 | 
				
			||||||
    "outDir": "lib",                                     /* Specify an output folder for all emitted files. */
 | 
					    "outDir": "dist",                                     /* Specify an output folder for all emitted files. */
 | 
				
			||||||
    // "removeComments": true,                           /* Disable emitting comments. */
 | 
					    // "removeComments": true,                           /* Disable emitting comments. */
 | 
				
			||||||
    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
 | 
					    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
 | 
				
			||||||
    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
 | 
					    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user