# nodejs-mobile

**Repository Path**: verygoodgraphics/nodejs-mobile

## Basic Information

- **Project Name**: nodejs-mobile
- **Description**: Full-fledged Node.js on Android and iOS
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-05-24
- **Last Updated**: 2024-10-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Node.js for Mobile Apps

This is the main repository for *Node.js for Mobile Apps*, a toolkit for integrating Node.js into mobile applications.

## Resources for Newcomers

* [Frequently Asked Questions](./doc_mobile/FAQ.md)
* [Discussions](https://github.com/nodejs-mobile/nodejs-mobile/discussions)
* [(Old) Website](https://code.janeasystems.com/nodejs-mobile)

The core library source code is in this repo. If you are looking for the *source code* for the plugins, you can find it at:

* [React Native plugin source repo](https://github.com/nodejs-mobile/nodejs-mobile-react-native)
* [Cordova plugin source repo](https://github.com/nodejs-mobile/nodejs-mobile-cordova)


## Project Goals

1. To provide the fixes necessary to run Node.js on mobile operating systems.
1. To investigate which features need to be added to Node.js in order to make it a useful tool for mobile app development.
1. To diverge as little as possible from nodejs/node, while fulfilling goals (1) and (2).

## Download

Binaries for Android and iOS are available at https://github.com/nodejs-mobile/nodejs-mobile/releases.

## Documentation

(Old) Documentation can be found on the [project website](https://code.janeasystems.com/nodejs-mobile). Sample code is available in the [(old) samples repo](https://github.com/janeasystems/nodejs-mobile-samples/).

***Disclaimer:***  documentation found in this repository is currently unchanged from parent repository and may only be applicable to upstream node.

## Versioning

This project does *NOT* follow SemVer, instead it aims to reflect the upstream Node.js version is is based on.

`nodejs-mobile` version `A.B.C` is based on Node.js version `A.B.*`, while the `C` is incremented whenever there are *any* changes to our codebase, be them fixes, features or otherwise.

## Build Instructions

Please see the [BUILDING.md](./doc_mobile/BUILDING.md) file in the `doc_mobile` folder in this source distribution.

## Running tests

Please see the [TESTING.md](./doc_mobile/TESTING.md) file in the `doc_mobile` folder in this source distribution.

## Contributing

Please see the [CONTRIBUTING](./doc_mobile/CONTRIBUTING.md) file in the `doc_mobile` folder in this source distribution.