Getting started

Getting Started

Requirements

Ensure you have the following installed:

  • Node.js (LTS recommended, only to run the project locally)
  • Git

Cloning the Repository

Clone this repository:

git clone git@github.com:releasysaas/reposter.git

Move to the folder just cloned:

cd reposter

Set your private repository url:

git remote set-url origin git@github.com:<my-github-user>/reposter.git

Set this repository as your upstream fork, so you can pull updates when needed:

git remote add upstream git@github.com:releasysaas/reposter.git

We recommend to watch to the repository, so you know when there's an update. To pull the latest updates, use:

git pull upstream main

In case we change the same files, you will need to resolve the conflicts.

Alternatively, you can cherry-pick changes so to reduce the amount of conflicts across the files.

Installing the Node Modules

Install the Node modules with the following command:

npm i

If you want to run it locally, just type:

npm run dev

Create the local variables

Copy the .env.example file into a .envfile

Below the list of the main variables:

# -----------------------------------------------------------------------------
# NextAuth
# -----------------------------------------------------------------------------
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=uhf3trtertrewter8e7y7fh38rerewt7uc435h3fi347u4rh9394hf

# -----------------------------------------------------------------------------
# X OAuth
# -----------------------------------------------------------------------------
X_OAUTH2_CLIENT_ID=
X_OAUTH2_CLIENT_SECRET=

# -----------------------------------------------------------------------------
# Database URI
# -----------------------------------------------------------------------------
MONGODB_URI=

# -----------------------------------------------------------------------------
# Application Settings
# -----------------------------------------------------------------------------
MAX_ALLOWED_USERS=1
PUBLISH_ENABLED=true
SCHEDULE_SECRET=ehetrhtrewtregdfhtryterjhgfdbhertteruytrythfgsgsf

# -----------------------------------------------------------------------------
# OPENAI (Optional)
# -----------------------------------------------------------------------------
OPENAPI_KEY=
OPENAPI_MODEL=gpt-3.5-turbo

# -----------------------------------------------------------------------------
# S3 SETTINGS (Optional for uploading images)
# -----------------------------------------------------------------------------
S3_UPLOAD_KEY=
S3_UPLOAD_SECRET=
S3_UPLOAD_BUCKET=name-of-s3-bucket
S3_UPLOAD_REGION=us-east-1

# -----------------------------------------------------------------------------
# X V1 API (Optional for uploading images)
# -----------------------------------------------------------------------------
X_CONSUMER_KEY=
X_CONSUMER_SECRET=
X_ACCESS_TOKEN=
X_ACCESS_SECRET=
IntroductionSetup MongoDB