README.md

Topcoder - Challenge Creation App UI

This is the frontend application for creating and managing challenges.

Development deployment status

Production deployment status

Intended use

• UI for creating challenges

Related repos

• Challenge API - The API endpoint for challenges
• Resources API - The API endpoint for resources
• Projects API
• Challenge ES Processor - Updates challenge data in ElasticSearch
• Resource ES Processor - Updates resource data in Elasticsearch

Prerequisites

• NodeJS (v10.15+)
• Docker
• Docker Compose

Configuration

Production configuration is in config/constants/production.js Development configuration is in config/constants/development.js

Local Deployment Instructions

1. First install dependancies

npm install

1. copy the environment file in docs/dev.env to /.env

2. If you are using local instances of the API's, change the DEV_API_HOSTNAME in configs/constants/development.js to match your local api endpoint.

   • For example change it to 'http://localhost:3000/',

3. Run the app in development mode

npm run dev

You can access the app from http://localhost:3000/

The page will reload if you make edits.

You will also see any lint errors in the console.

Lint check

To test the app for lint errors

npm run lint

Use the --fix flag to automatically fix errors.

Production deployment

To build the app for production

npm run build

Builds the app for production to the build folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

If you want to test to production build locally you can run

npm install -g serve
serve -s build

It serves the build folder locally.

Heroku Deployment

To deploy the app on heroku run

git init
heroku create tc-challenge-creation-app --buildpack mars/create-react-app
git add .
git commit -m "Heroku commit"
git push heroku master

You can access the app by running

heroku open

Running tests

Configuration

Test configuration is at config/env.js. You don't need to change them. for testing run below command

npm run test

Running tests in CI

• TBD

Verification

• TBD