https://github.com/gplopes/eventio
Eventio
https://github.com/gplopes/eventio
Last synced: 8 months ago
JSON representation
Eventio
- Host: GitHub
- URL: https://github.com/gplopes/eventio
- Owner: gplopes
- Created: 2018-11-03T11:45:35.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-23T22:42:33.000Z (over 7 years ago)
- Last Synced: 2025-02-01T16:22:01.187Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://eventio-jgpsutueil.now.sh
- Size: 27.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Eventio
“Use the force, Luke.” ...
# Getting Started
to develop:
```
> npm install
> npm run dev
```
to build:
```
> npm run build
```
# Folder Structure
`./pages` - served pages
`./static` - public site folder
`./src/api` - api config and helper functions
`./src/auth` - authentication server logic
`./src/components` - reusable components
`./src/layouts` - global layout components
`./src/lib` - 3rd party libs
`./src/store` - app store and wrappers (Context)
`./src/styles` - global styles
`./src/utils` - js utils functions
# Code Guide
1. Component's styles are imported directly to the component
or the parent's component and named after the component/folder name
2. CSS Class should be followed by the Component's name.
- import the styles core into your module style so you can have access
to the theme and global sass functions
```js
// Icon.js
import "./Icon.styles.scss";
function Icon() {
return
;
}
```
```scss
// Icon.styles.scss
@import "./src/styles/core.scss";
.Icon {
}
```
3. Every Page should be wrapped with `` component
4. Layout are broken into section, to keep render function cleaner
you can use `` wrapper
```jsx
import { Page, Section } from "./src/layouts";
function Login() {
return (
Section with Component
Section without component
);
}
```
## Test
Test still needs to be written, the jest is already plugged on the project.
```
> npm test
```
## Release
```
> npm install -g now
> now
```
## Built with
- [Nextjs](https://github.com/zeit/next.js)
- [React](http://reactjs.org)
- [Now](https://zeit.co/now)
# TODO
### SignUp
status: layout and logic is pretty much done, it needs to
connect to the api and do the correct redirection
### Event Detail
status: a few components done, it can display the event but
edit option needs work
### Handle Better Preload Image
to give better 'feedback' to the user using the site for the first