Boost Collective is a web application that allows small groups of friends to promote one another's tweets.
Before you begin, make sure you have the following installed on your local machine:
- Node.js
- npm
Also, make sure you have the following credentials:
- Twitter API keys (API Key, API Key Secret, Access Token, Access Token Secret)
- AWS credentials (Access Key ID, Secret Access Key, Region)
-
Download and unzip the project files.
-
Navigate to the project directory in a terminal.
-
Install the dependencies by running
npm install
. -
Create a
.env
file in the project directory and add your Twitter API keys, AWS credentials, and a session secret. Use the.env.template
file as a guide.
-
In one terminal, start the server by running
npm start
. This will start the server onlocalhost:3000
. -
In a second terminal, navigate to the same project directory and run
npm run client
. This will start the Parcel server onlocalhost:1234
.
You can now access the app at localhost:1234
in your browser.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.