NameFunk is the application for programmers around the globe to cut down on decision fatigue by telling you what to name your functions. Simply enter a term that defines your project and NameFunk will provide you with ideas. Create an account to save your function names and come back later to reference them.
This version uses React, Redux, Express, Passport, and PostgreSQL.
Additional Technologies listed below (see "Additional Technologies Used"), and a full list of dependencies can be found in package.json
.
Before you get started, make sure you have the following software installed on your computer:
NameFunk uses the API from Merriam-Webster's Collegiate Thesaurus.
Sign up for an API Key at: Merriam-Webster's Collegiate Thesaurus
See "Installation Instructions" below for information on setting your API Key.
Create a new database called namefunk
and create tables using the SQL commands located in the database.sql file
If you would like to name your database something else, you will need to change namefunk
to the name of your new database name in server/modules/pool.js
- Run
npm install
- Create a
.env
file at the root of the project and paste these two lines into the file:While you're in your newMW_THESAURUS_API_KEY=merriamWebsterApiKey SERVER_SESSION_SECRET=superDuperSecret
.env
file, replacemerriamWebsterApiKey
with the API Key you received from Merriam-Webster's Collegiate Thesaurus (see "API Key" if you do not have an API Key). Also, take the time to replacesuperDuperSecret
with some long random string like25POUbVtx6RKVNWszd9ERB9Bb6
to keep the application secure. Here's a site that can help you: https://passwordsgenerator.net/. You will receive a warning if you create a secret with less than eight characters or leave it assuperDuperSecret
. - Start postgres if not running already by using
brew services start postgresql
- Run
npm run server
- Run
npm run client
- Navigate to
localhost:3000
Before pushing to Heroku, run npm run build
in terminal. This will create a build folder that contains the code Heroku will be pointed at. You can test this build by typing npm start
. Keep in mind that npm start
will let you preview the production build but will not auto update.
- Start postgres if not running already by using
brew services start postgresql
- Run
npm start
- Navigate to
localhost:5000
src/
contains the React applicationpublic/
contains static assets for the client-sidebuild/
after you build the project, contains the transpiled code fromsrc/
andpublic/
that will be viewed on the production siteserver/
contains the Express App
- HTML5
- CSS
- React.js
- React-Redux
- Redux-Saga
- Node.js
- Express
- Axios
- Material UI
- SweetAlert
- API from Merriam-Webster (for finding similar words)
- Create a new Heroku project
- Link the Heroku project to the project GitHub Repo
- Create an Heroku Postgres database
- Connect to the Heroku Postgres database from Postico
- Create the necessary tables
- Add an environment variable for
SERVER_SESSION_SECRET
with a nice random string for security - In the deploy section, select manual deploy
Pete St. Martin
Dane Smith Dev Jana Ally Boyd Chris Black Luke Schlangen Kris Szafranski Mary Mosman Baconian Cohort