reactos/developer-web-interface
1
0
Fork 0
mirror of https://github.com/reactos/developer-web-interface.git synced 2024-11-23 03:49:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated Readme

Browse Source
This commit is contained in:
Ayush Kumar Sinha 2019-09-17 22:30:48 +05:30
parent 7bd218c3d6
commit 1f116a3e29
2 changed files with 34 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1 +1,29 @@
# Developer Web Interface for ReactOS (GSOC 2019)
# Developer Web Interface for ReactOS
## About Project
---
Developer Web Interface for ReactOS is a web tool to support the development of ReactOS. The main goal of this project is to develop a platform for ReactOS developers to easily track Commits, Builds and Test details. The web Interface makes API calls to various endpoints of GitHub, BuildBot and Testman API and interrelates them and renders a simplified view of Commit, Build and Test details at one place.
### Installation
---
```bash
git clone https://github.com/reactos/developer-web-interface.git
npm install
cd client && npm install
```
> Create a .env file in root directory and include your GitHub API key ( check config-Env )
### Run Application
---
On root Directory
```bash
npm run dev
```

5
config-Env Normal file
View File

@ -0,0 +1,5 @@
//sample .env file
/*create .env file with the fields given below
/*when setting up this project on local machine
SECRET=<your github api access token>