Table of Contents
Growing up, there was this game that I loved playing on my mum’s phone. However, I recently checked the app store and couldn’t find any version that met my expectations. So I built a web app version of the game. I didn’t want to keep the fun to myself though so check it out.
- Clone the repo
git clone https://github.com/PhiAgent/WordHunter.git
- Install NPM packages
npm install
- Create a config.js file in database/psql with your local psql connection details like this database/psql/config.js:
module.exports = {
host: "localhost",
user: "your name",
database: "word_game",
password: "",
port: 5432,
max: 30,
idleTimeoutMillis: 1,
};
- Uncomment the last line in database/psql/db.js.
- Populate the database by navigating to the root folder in your application in your terminal and run:
node database/psql/db.js
- Recomment the last line in database/psql/db.js.
- Create a config.env file in server like so server/config.env and put your port information like so:
PORT=5000
- Run in your terminal:
npm run build-dev
- Now start your server by running in your terminal:
npm start
- Open localhost http://localhost:5000/ in your browser
See the open issues for a full list issues.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request