Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sodhanalibrary/ftmocks-server
https://github.com/sodhanalibrary/ftmocks-server
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sodhanalibrary/ftmocks-server
- Owner: SodhanaLibrary
- License: mit
- Created: 2024-10-11T14:36:38.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-10T12:11:13.000Z (3 months ago)
- Last Synced: 2024-11-10T13:20:05.442Z (3 months ago)
- Language: JavaScript
- Size: 2.86 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FtMocks
## Overview
**FtMocks** is a Node.js application that will simplify your maintainance of mock data. This project was created to acheive full code coverage for your frontend project.
## Features
- Easy maintanance of mock data for test cases
- Default mock data for all test cases
- Mock server for the test case
## Documentation
- Please visit FtMocks(www.ftmocks.com)
## Getting Started
### Prerequisites
To run this project, ensure you have the following installed on your machine:
- [Node.js](https://nodejs.org/) (version 20 or later)
- [npm](https://www.npmjs.com/) (usually included with Node.js)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/SodhanaLibrary/ftmocks-server.git
```
2. Navigate into the project directory:
```bash
cd ftmocks-server
```
3. Install dependencies:
```bash
npm i
```
### Configuration
1. Create my-project.env file for your project
2. Create a my-project.env file in the project root.
```bash
MOCK_DIR=/Users/srinivas.dasari/Documents/CursorWorkSpace/ftmocks-server/sample/my-project
PORT=5000
MOCK_DEFAULT_FILE=default.json
MOCK_DEFAULT_DIR=defaultMocks
MOCK_TEST_FILE=tests.json
```
### Running the Project
To start the project, use:
```bash
npm start my-project
```
### Contributing
Contributions are welcome! Please fork this repository and create a pull request.
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