Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zeroxme/framer-template
Framer JS starter template for prototyping
https://github.com/zeroxme/framer-template
Last synced: about 1 month ago
JSON representation
Framer JS starter template for prototyping
- Host: GitHub
- URL: https://github.com/zeroxme/framer-template
- Owner: zeroxme
- License: mit
- Created: 2022-09-19T16:03:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-05T08:18:16.000Z (about 2 years ago)
- Last Synced: 2024-10-12T11:10:53.649Z (2 months ago)
- Language: HTML
- Size: 1.62 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Framer starter template
A starter template with webpack to help you prototype in FramerJS with JavaScript.
Original Framer library: https://github.com/koenbok/Framer
### Setup
Make sure you have `node` and `npm` installed.
Clone this repo
```
git clone [email protected]:zeroxme/framer-template.git
```
then
```
cd framer-template
npm install
```
### How to use it
To run the project in your local server
```
npm start
```
Then in your browser, go to `http://localhost:3000`
Or run it on your mobile device, go to `[your local ip address]:3000` for example `http://192.168.2.151:3000`
The best way to run it full screen on your device is to open it on Safari (iOS) or Chrome (Android) then `Add to home screen`
Start making changes to `src/app.js` and see your changes apply
To build and deploy locally
```
npm run build
```
I've uploaded the example on Netlify https://framer-template.netlify.app/
### Documentation
For Documentation is https://docs.prototyper.design/
Prototyper documentation is pretty much the same. The only difference is that anything that starts with `Prototyper` should be `Framer` instead.
WIP: To bring back the original Framer documentation.
### Warning
Please don't make changes to `public/` folder as it has everything Framer related so it can work
### Collaborate
For any questions or issues, feel free to open an issue here.
find me [@zerox_me](https://twitter.com/zerox_me)