mirror of
				https://github.com/keanuplayz/TravBot-v3.git
				synced 2024-08-15 02:33:12 +00:00 
			
		
		
		
	Added test suite and production builder
This commit is contained in:
		
							parent
							
								
									4a6754d21e
								
							
						
					
					
						commit
						8ca171e924
					
				
					 8 changed files with 1281 additions and 5 deletions
				
			
		
							
								
								
									
										16
									
								
								docs/GettingStarted.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								docs/GettingStarted.md
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,16 @@ | |||
| # Getting Started | ||||
| 1. `npm install` | ||||
| 2. `npm run build` | ||||
| 3. `npm start` | ||||
| 
 | ||||
| # Getting Started (Developers) | ||||
| 1. `npm install` | ||||
| 2. `npm run dev` | ||||
| 3. Familiarize yourself with the [project's structure](Specifications.md). | ||||
| 4. Make sure to avoid using `npm run build`! This will remove all your dev dependencies (in order to reduce space used). Instead, use `npm run once` to compile and build in non-dev mode. | ||||
| 5. Begin developing. | ||||
| 
 | ||||
| ## Don't forget to... | ||||
| - ...update the [changelog](CHANGELOG.md) and any other necessary docs. | ||||
| - ...update the version numbers in `package.json` and `package-lock.json`. | ||||
| - ...make sure the test suite passes by running `npm test`. | ||||
|  | @ -9,6 +9,7 @@ The top-level directory is reserved for files that have to be there for it to wo | |||
| 		- `<file>.ts`: All commands at this level will have the `Miscellaneous` category. | ||||
| 	- `events`: Here's the place to store events. The file name determines the event type. | ||||
| - `dist`: This is where the runnable code in `src` compiles to. (The directory structure mirrors `src`.) | ||||
| - `test`: Used for all the unit tests. | ||||
| - `data`: Holds all the dynamic data used by the bot. This is what you modify if you want to change stuff for just your instance of the bot. | ||||
| - `standard`: Contains all the standard data to be used with the project itself. It's part of the code and will not be checked for inaccuracies because it's not meant to be easily modified. | ||||
| - `docs`: Used for information about the design of the project. | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue