Codetropy

A npm package for watching over your project in order to avoid copying huge chunks of codes in any short format coding competition/hackathons.
· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Codetropy is a set of microservice which watches over your project directory and calculates the change in the total as well as the specific file by continuously watching over the addition and deletion of characters within the project directory.

(back to top)

Built With

Tools that were used in the process of making this microservice are:

• Typescript
• Node.js
• Express
• React

(back to top)

Components

• Codetropy - A npm package written in typescript which should be downloaded in the project directory. This package will send the changes to the server where the data will be processed accordingly.

• Codetropy-server - This is a server for codetropy written in typescript and express framework. Its main usecase is to collect data from the package and store the hashmap in the redis database.

• Codetropy-dashboard - A simple front end written in React to display the graphs team/project wise.

Getting Started

To get a local copy up and running follow these simple steps:

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Install the codetropy package locally in the project structure.

   npm install codetropy

2. Start the codetropy process using the following command

   codetropy start

3. Enter the team/project name and codetropy will start running

   

4. Go to /dashboard/teamname to get the graph for your project.

(back to top)

Usage

After starting the package go to /dashboard/teamname to monitor the change in lines of code.

Following files and folders are ignored by default

• node_modules
• package.json
• package-lock.json
• .git

(back to top)

Roadmap

• Add readme
• Add support for adding ignored files/folder

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - Tanay - tanay.raj76@gmail.com

Project Link: https://github.com/tanay13/codetropy

(back to top)