todo installation and attributions/pikachu added.
This commit is contained in:
		
							parent
							
								
									fafade4186
								
							
						
					
					
						commit
						b2b7321485
					
				
							
								
								
									
										13
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										13
									
								
								README.md
									
									
									
									
									
								
							| @ -6,10 +6,23 @@ Only supports female clothes for now, and has only been checked against a | ||||
| Pokémon Moon cartridge (and a bulbapedia clothes list.) | ||||
| Another check against Pokémon Sun would be useful. | ||||
| 
 | ||||
| I run a public version of the site at: TODO: pikachu.rocks | ||||
| 
 | ||||
| Currently, you need to have an account on the site to be able to use the tracker. | ||||
| Also, there is no e-mail server connected, so e-mails are not verified, | ||||
| and password resets and e-mail changes have to be done by contacting the admin. | ||||
| 
 | ||||
| ## TODO: Installation | ||||
| Here is how to spin up your own Pokémon Couture Instance. | ||||
| 1. Make sure you have [Elixir](https://elixir-lang.org/install.html), [Phoenix](https://hexdocs.pm/phoenix/installation.html), and a database like [PostgreSQL](https://wiki.postgresql.org/wiki/Detailed_installation_guides) installed. Also make sure that you have a C compiler and make. | ||||
| 2. Clone this git repository. | ||||
| 3. In the repository folder, run `mix deps.get` | ||||
| 4. If you're running the app in prod, edit the prod.exs and prod.secret.exs files with config: url host, database info and secret key base. | ||||
| 5. Run `mix ecto.setup` (`MIX_ENV=prod mix ecto.setup` when in prod.) | ||||
| 
 | ||||
| ## License and attributions | ||||
| `assets/static/images/pikachu.png` is a [pikachu icon by WEBTECHOPS LLP from the Noun Project](https://thenounproject.com/term/pokemon/2122740/), licensed as Creative Commons CCBY. | ||||
| 
 | ||||
| ## Possible future improvements | ||||
| While the app is currently in a state that works, there are some improvements I would like to make for it later down the line. | ||||
| 
 | ||||
|  | ||||
							
								
								
									
										
											BIN
										
									
								
								assets/static/images/pikachu.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								assets/static/images/pikachu.png
									
									
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| After Width: | Height: | Size: 30 KiB | 
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user