Merge branch 'doc-updates' into 'master'
chore: Update README.md with basic usage instructions See merge request mythic-insight/legendary!33
This commit is contained in:
		
						commit
						29b52be269
					
				
					 1 changed files with 19 additions and 5 deletions
				
			
		
							
								
								
									
										24
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										24
									
								
								README.md
									
									
									
									
									
								
							| 
						 | 
					@ -1,5 +1,23 @@
 | 
				
			||||||
# Legendary
 | 
					# Legendary
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# Up and Running
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					In order to start the server, run `script/server`. Any dependencies required
 | 
				
			||||||
 | 
					will be installed automatically using [brew](https://brew.sh/),
 | 
				
			||||||
 | 
					[asdf](https://asdf-vm.com/#/), and [hex](https://hex.pm/).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# CI Configuration
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Legendary comes with gitlab CI settings which should work for you with minimal
 | 
				
			||||||
 | 
					setup.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					The CI script will automatically tag successful builds. To do this, you will
 | 
				
			||||||
 | 
					need to configure a [CI variable](-/settings/ci_cd) named `GITLAB_TOKEN`. This
 | 
				
			||||||
 | 
					token should be a [personal access token](/-/profile/personal_access_tokens) with
 | 
				
			||||||
 | 
					`read_repository, write_repository` permissions.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
To start your Phoenix server:
 | 
					To start your Phoenix server:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  * Install dependencies with `mix deps.get`
 | 
					  * Install dependencies with `mix deps.get`
 | 
				
			||||||
| 
						 | 
					@ -7,11 +25,7 @@ To start your Phoenix server:
 | 
				
			||||||
  * Install Node.js dependencies with `npm install` inside the `assets` directory
 | 
					  * Install Node.js dependencies with `npm install` inside the `assets` directory
 | 
				
			||||||
  * Start Phoenix endpoint with `mix phx.server`
 | 
					  * Start Phoenix endpoint with `mix phx.server`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
 | 
					# Learn more
 | 
				
			||||||
 | 
					 | 
				
			||||||
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Learn more
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
  * Official website: https://www.phoenixframework.org/
 | 
					  * Official website: https://www.phoenixframework.org/
 | 
				
			||||||
  * Guides: https://hexdocs.pm/phoenix/overview.html
 | 
					  * Guides: https://hexdocs.pm/phoenix/overview.html
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in a new issue