These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Node.js (Preferably at least 10.5.0)
- A Command line program like Terminal (Mac) or GitBash (Windows)
- A browser (tested with Google Chrome, IE, Edge and FireFox)
- Clone the project files.
- Paste the .env file into the root folder of the project. If you just have the text for the file, you will need to open an ide like Atom, VS Code, or Notepad++ to create one in. Windows won't let you just create a file named .env.
- Install Node.js if not already installed. See 'Notes' section for install instruction links.
- Open a command line program. GitBash is recommended for Windows.
- Check that Node.js and NPM are installed by typing 'npm -v' and 'node -v' into your command line program. In both cases you should get some text displaying a version number.
- Using cd commands navigate to the root folder of the program. If you are using GitBash, you can open the root folder of the project, and right-click in the empty space to select 'GitBash Here'. This will open GitBash witht he location already set to the root folder.
- Type 'npm install' in your command line program so it will install the dependencies for the program.
- Type 'npm start' or 'node src/server.js' to start the program. See 'Notes' section if you expreience issues loading the app here.
- Navigate to http://localhost:4242 in a browser window. You should now be at the home page of the program. See 'Notes' section if you have issues loading this in a particular browser.
- Express - A Node.js web application framework
- Bootstrap 3.3.7 - A HTML, CSS, and JS Framework used for some visual customization and responsive features of the program.
- Nodemon - Monitors changes in the program and reloads it so you don't have to after every change.
If you encounter some errors, when you type 'node src/server.js' or 'npm start' in your command line tool, you may need to type 'npm install nodemon -g' to install Nodemon. Since this was added to the dependencies, it should install when you type 'npm install', but there is always a chance it won't.
###Issues with Browsers
If you go to load the app in Chrome and it refuses to load citing a security issue or protocol issue, try loading it by going to 127.0.0.1:4242 instead of localhost:4242. In IE, you can load it with localhost:port or the ip:port combination, but you may have to manually type http:// before it before it will load. No issues were experienced with Firefox during testing, but that does not mean they will not introduce something to cause the same issues soon.
EGrayTech - Initial work
Project inspiration from the May 2018 Session FSJS Thursday class project and the Pokedex featured in Gamefreak's Pokemon franchise.