- 1. Catbird - Retail Web Portal Re-design / Overhaul
- 2. Introduction
- 3. Project Setup:
- 4. Configuring and running the server.
Catbird is a complete re-design and overhal over its predecessor, Birdcat, using modern technologies and design elements with a refreshing and intuitive user intercace. By building Catbird using React Components, users can expect a responsive and snappy user interface that makes the retail experience quick, easy, and enjoyable.
Download and install the following:
Clone the repository by executing the following commands into your terminal and navigate into the cloned directory:
git clone https://github.com/Project-Catbird/Catbird.git
cd Catbird
Install the the project dependencies buy executing:
npm install
- Log in to GitHub and navigate to Personal Access Token Settings
- Click "Generate new token"
- Given the Token a Description ("Hack Reactor Capstone API", or whatever is most descriptive to you)
- Under Select Scopes, select the following: (You may select more for more features this API will offer in the future)
- read:org
- user
- read:user
- user:email
- user:follow
- Generate Token
- Note that this token is only viewable once, at generation time. Make sure to copy it to a secure place and never check it into your git history.
If you token is compromised (e.g. it is accidentally checked into git or unwittingly becomes part of a Webpack build) make sure to revoke the token immediately. You may generate a replacement token if necessary.
From the Catbird folder, navigate to ./client/src/config/ and create a new file named config.js Copy the contents from exampleConfig.js to config.js then replace PERSONAL_ACCESS_TOKEN with the token generated from the previous step.
To start the server, run the following terminal command from the root directory:
npm start
By default, the server will be serving Catbird to http://localhost:3000/
To terminate the server, press Ctrl + C in your server terminal.