Skip to content

Latest commit

 

History

History
176 lines (118 loc) · 8.59 KB

README.md

File metadata and controls

176 lines (118 loc) · 8.59 KB
Raw

Codedigger Frontend

Codedigger Codedigger API

Contributors Forks Stargazers Issues

Apache License Contributor Covenant

LinkedIn Discord

Table of Contents

  1. Introduction

  2. Getting Started

    1. Fork, clone locally and create a branch
    2. Setting Environment First Time
    3. Starting Development Server
    4. Using Docker

  3. Code of Conduct

  4. Contributing

  5. License

  6. How to Get Help

Introduction

This is the main Frontend Repository of the Codedigger Website.

Codedigger aims at accumulating the data of competitive programming platforms (Codeforces, Codechef, Atcoder, SPOJ and UVA Online Judge) into one platform. We used their publicly available APIs and introduced several unique features into our application such as friends, mentors, ladders, upsolve, problem and contest filter. This can be the ultimate stop for everyone practicing competitive programming.

User can practice topicwise list to expertise any topic, levelwise list to practice based on rating and difficulty, or can create their own list and follow that. They can filter problems based on difficulty, tag, or solved by mentor from all the sites combined at one place.

Upsolving means to solve those problems, you're not able to solve during the contest. With the help of codedigger, you will be able to upsolve codeforces, codechef, and atcoder contests in an easy and better way.

Getting Started

Fork, clone locally & create a branch

Fork Codedigger Frontend repository and clone at your local

git clone https://github.com/<yourGithubUsername>/Frontend.git
cd Frontend/

Create a branch with a descriptive name. A good branch name would be :

git checkout -b feature/AmazingFeature
git checkout -b bugfix/user

Setting Environment First Time

Windows

Follow these steps to set your virtual environment for Windows.

Linux

Follow these steps to set your virtual environment for Linux.

Starting Development Server on Windows/Linux

npm install && npm start
Navigate to localhost:3000/ to open the website.

Using Docker

For those familiar with Docker, you can also build and run the project through a container.

Development build

Building and running a static container:

docker build . -t frontend:dev
docker run -p 3000:3000 frontend:dev

To build and run a container with live-reload for development, use docker compose instead:

docker-compose up -d

Production Build

docker build . -f Dockerfile.prod -t frontend:prod
docker run -p 80:80 frontend:prod

Code of Conduct

This project and everyone participating in it is governed by the Codedigger Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Contributing

We encourage you to participate in this open source project. We love Pull Requests, Bug Reports, ideas, (security) code reviews or any other kind of positive contribution. Please review CONTRIBUTING.md for details on how to file an issue or pr.

License

Copyright 2021 Codedigger

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

How to Get Help

Email us - [email protected]

Join! our Discord Community

Back to top